Skip to content

[office-js][office-js-preview] (OfficeTheme) Document isDarkTheme and themeId properties #69663

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.

Sign up for GitHub

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

Merged
ElizabethSamuel-MSFT merged 2 commits into from
Jun 20, 2024
Merged

[office-js][office-js-preview] (OfficeTheme) Document isDarkTheme and themeId properties #69663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cf020f
Document isDarkTheme and themeId properties
samantharamon May 22, 2024
248a70b
Update isDarkTheme description
samantharamon Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 51 additions & 7 deletions types/office-js-preview/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3068,6 +3068,30 @@ declare namespace Office {
*/
Headers
}
/**
* Specifies the Office theme that's currently selected.
*
* For information on Office themes, see
* {@link https://support.microsoft.com/office/63e65e1c-08d4-4dea-820e-335f54672310 | Change the look and feel of Microsoft 365}.
*/
enum ThemeId {
/**
* The currently selected Office theme is **Black**.
*/
Black,
/**
* The currently selected Office theme is **Colorful**.
*/
Colorful,
/**
* The currently selected Office theme is **Dark Gray**.
*/
DarkGray,
/**
* The currently selected Office theme is **White**.
*/
White
}
/**
* Specifies whether values, such as numbers and dates, returned by the invoked method are returned with their formatting applied.
*
Expand Down Expand Up @@ -6978,10 +7002,14 @@ declare namespace Office {
/**
* Provides access to the properties for Office theme colors.
*
* Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user with **File** \>
* **Office Account** \> **Office Theme UI**, which is applied across all Office applications. Using Office theme colors is appropriate for mail and
* Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user.
* The user sets a theme in an Office application through **File** \> **Account** or **Office Account** \> **Office Theme**.
* The selected theme is then applied across all Office applications. Using Office theme colors is appropriate for mail and
* task pane add-ins.
*
* For more information on Office themes, see
* {@link https://support.microsoft.com/office/63e65e1c-08d4-4dea-820e-335f54672310 | Change the look and feel of Microsoft 365}.
*
* @remarks
*
* *Supported applications, by platform*
Expand All @@ -6996,23 +7024,23 @@ declare namespace Office {
* </tr>
* <tr>
* <td><strong>Excel</strong></td>
* <td>Not available</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Not available</td>
* </tr>
* <tr>
* <td><strong>Outlook</strong></td>
* <td>Supported\*</td>
* <td>Supported\*</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Not available</td>
* <td>Not available</td>
* <td>Not available</td>
* </tr>
* <tr>
* <td><strong>PowerPoint</strong></td>
* <td>Not available</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
Expand All @@ -7028,7 +7056,7 @@ declare namespace Office {
* </tr>
* </table>
*
* \* In Outlook, the Office theme API is supported starting in
* **Important**: In Outlook, the Office theme API is supported starting in
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
* It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
*/
Expand All @@ -7049,6 +7077,22 @@ declare namespace Office {
* Gets the Office theme control foreground color as a hexadecimal color triplet (e.g., "#FFA500").
*/
controlForegroundColor: string;
/**
* Returns `true` if the Office theme that's currently selected is **Black** (dark mode) or **Dark Gray**.
*
* @remarks
*
* **Important**: The `isDarkTheme` property isn't yet supported in Outlook.
*/
isDarkTheme: boolean;
/**
* Gets the Office theme that's currently selected.
*
* @remarks
*
* **Important**: The `themeId` property isn't yet supported in Outlook.
*/
themeId: ThemeId;
}
/**
* Specifies a cell, or row, or column, by its zero-based row and/or column number. Example: `{row: 3, column: 4}` specifies the cell in the 3rd
Expand Down
58 changes: 51 additions & 7 deletions types/office-js/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3068,6 +3068,30 @@ declare namespace Office {
*/
Headers
}
/**
* Specifies the Office theme that's currently selected.
*
* For information on Office themes, see
* {@link https://support.microsoft.com/office/63e65e1c-08d4-4dea-820e-335f54672310 | Change the look and feel of Microsoft 365}.
*/
enum ThemeId {
/**
* The currently selected Office theme is **Black**.
*/
Black,
/**
* The currently selected Office theme is **Colorful**.
*/
Colorful,
/**
* The currently selected Office theme is **Dark Gray**.
*/
DarkGray,
/**
* The currently selected Office theme is **White**.
*/
White
}
/**
* Specifies whether values, such as numbers and dates, returned by the invoked method are returned with their formatting applied.
*
Expand Down Expand Up @@ -6968,10 +6992,14 @@ declare namespace Office {
/**
* Provides access to the properties for Office theme colors.
*
* Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user with **File** \>
* **Office Account** \> **Office Theme UI**, which is applied across all Office applications. Using Office theme colors is appropriate for mail and
* Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user.
* The user sets a theme in an Office application through **File** \> **Account** or **Office Account** \> **Office Theme**.
* The selected theme is then applied across all Office applications. Using Office theme colors is appropriate for mail and
* task pane add-ins.
*
* For more information on Office themes, see
* {@link https://support.microsoft.com/office/63e65e1c-08d4-4dea-820e-335f54672310 | Change the look and feel of Microsoft 365}.
*
* @remarks
*
* *Supported applications, by platform*
Expand All @@ -6986,23 +7014,23 @@ declare namespace Office {
* </tr>
* <tr>
* <td><strong>Excel</strong></td>
* <td>Not available</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Not available</td>
* </tr>
* <tr>
* <td><strong>Outlook</strong></td>
* <td>Supported\*</td>
* <td>Supported\*</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Not available</td>
* <td>Not available</td>
* <td>Not available</td>
* </tr>
* <tr>
* <td><strong>PowerPoint</strong></td>
* <td>Not available</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
* <td>Supported</td>
Expand All @@ -7018,7 +7046,7 @@ declare namespace Office {
* </tr>
* </table>
*
* \* In Outlook, the Office theme API is supported starting in
* **Important**: In Outlook, the Office theme API is supported starting in
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/requirement-set-1.14/outlook-requirement-set-1.14 | Mailbox requirement set 1.14}.
* It isn't supported in Outlook add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
*/
Expand All @@ -7039,6 +7067,22 @@ declare namespace Office {
* Gets the Office theme control foreground color as a hexadecimal color triplet (e.g., "#FFA500").
*/
controlForegroundColor: string;
/**
* Returns `true` if the Office theme that's currently selected is **Black** (dark mode) or **Dark Gray**.
*
* @remarks
*
* **Important**: The `isDarkTheme` property isn't yet supported in Outlook.
*/
isDarkTheme: boolean;
/**
* Gets the Office theme that's currently selected.
*
* @remarks
*
* **Important**: The `themeId` property isn't yet supported in Outlook.
*/
themeId: ThemeId;
}
/**
* Specifies a cell, or row, or column, by its zero-based row and/or column number. Example: `{row: 3, column: 4}` specifies the cell in the 3rd
Expand Down