Skip to content

[Excel/Word] (keyboard shortcuts) Create a unified manifest for the sample #958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

samantharamon
Copy link
Contributor

Q A
Bug fix? no
New feature? no
New sample? no
Related issues? none

What's in this Pull Request?

Adds a unified manifest to the keyboard shortcuts sample.

@samantharamon samantharamon added the Do Not Merge This PR has additional work or review required before it is ready to merge. label Jun 9, 2025
Copy link
Collaborator

@ElizabethSamuel-MSFT ElizabethSamuel-MSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also be sure to update the assets/sample.json (updateDateTime; the thumbnails url gives me a 404 so consider using this link instead: https://raw.githubusercontent.com/OfficeDev/Office-Add-in-samples/main/Samples/office-keyboard-shortcuts/assets/office-keyboard-shortcuts-overview.png)

- <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd>: Performs an action that's specific to the current Office host.
- **Excel**: Cycles through colors in the currently selected cell.
- **Word**: Adds text to the document.
| Action | Windows | Mac | Web |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider reordering so web is first...

Suggested change
| Action | Windows | Mac | Web |
| Action | Web | Windows | Mac |

Comment on lines +26 to +28
| Open the add-in's task pane | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up arrow key</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Up arrow key</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>1</kbd> |
| Hide the add-in's task pane | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down arrow key</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Down arrow key</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>2</kbd> |
| Perform an action that's specific to the current Office host<br>- **Excel**: Cycle through colors in the currently selected cell<br>- **Word**: Add text to the document | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Q</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>3</kbd> |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Open the add-in's task pane | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up arrow key</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Up arrow key</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>1</kbd> |
| Hide the add-in's task pane | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down arrow key</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Down arrow key</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>2</kbd> |
| Perform an action that's specific to the current Office host<br>- **Excel**: Cycle through colors in the currently selected cell<br>- **Word**: Add text to the document | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Q</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>3</kbd> |
| Open the add-in's task pane | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>1</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up arrow key</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Up arrow key</kbd> |
| Hide the add-in's task pane | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>2</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down arrow key</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Down arrow key</kbd> |
| Perform an action that's specific to the current Office host<ul><li>**Excel**: Cycle through colors in the currently selected cell</li><li>**Word**: Add text to the document</li></ul> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>3</kbd> | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> | <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Q</kbd> |

Comment on lines +98 to +99
- **Excel**: `npm run start:desktop:excel`
- **Word**: `npm run start:desktop:word`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is indented enough... The rest of the list shouldn't restart numbering

Suggested change
- **Excel**: `npm run start:desktop:excel`
- **Word**: `npm run start:desktop:word`
- **Excel**: `npm run start:desktop:excel`
- **Word**: `npm run start:desktop:word`

Comment on lines +142 to +143
- **Excel**: `npm run start:desktop:excel`
- **Word**: `npm run start:desktop:word`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is indented enough...

Suggested change
- **Excel**: `npm run start:desktop:excel`
- **Word**: `npm run start:desktop:word`
- **Excel**: `npm run start:desktop:excel`
- **Word**: `npm run start:desktop:word`

Comment on lines 161 to 162
> [!NOTE]
> If the keyboard shortcut is already in use in Excel or Word, a dialog will be shown so that you can select which action you'd like to map to the shortcut. Once you select an action, you can change your preference by invoking the **Reset Office Add-in Shortcut Preferences** command from the search field.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is indented enough... you should also indent the rest of the note lines (i.e., >)

Suggested change
> [!NOTE]
> If the keyboard shortcut is already in use in Excel or Word, a dialog will be shown so that you can select which action you'd like to map to the shortcut. Once you select an action, you can change your preference by invoking the **Reset Office Add-in Shortcut Preferences** command from the search field.
> [!NOTE]
> If the keyboard shortcut is already in use in Excel or Word, a dialog will be shown so that you can select which action you'd like to map to the shortcut. Once you select an action, you can change your preference by invoking the **Reset Office Add-in Shortcut Preferences** command from the search field.

@samantharamon
Copy link
Contributor Author

also be sure to update the assets/sample.json (updateDateTime; the thumbnails url gives me a 404 so consider using this link instead: https://raw.githubusercontent.com/OfficeDev/Office-Add-in-samples/main/Samples/office-keyboard-shortcuts/assets/office-keyboard-shortcuts-overview.png)

Thanks for the early review. I'm still working on this sample. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Do Not Merge This PR has additional work or review required before it is ready to merge.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants