Skip to content

feat(web-components): relax setTheme() argument type to allow custom tokens #32087

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
marchbox merged 2 commits into from
Jul 23, 2024
Merged

feat(web-components): relax setTheme() argument type to allow custom tokens #32087

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
5725569
relax theme type to allow custom tokens
marchbox Jul 23, 2024
4123733
add change file
marchbox Jul 23, 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
7 changes: 7 additions & 0 deletions change/@fluentui-web-components-664a860d-0606-46e5-9e2d-c1d7508e2e62.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "feat(web-components): relax setTheme() argument type to allow custom tokens",
"packageName": "@fluentui/web-components",
"email": "machi@microsoft.com",
"dependentChangeType": "patch"
}
6 changes: 5 additions & 1 deletion packages/web-components/docs/api-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import type { HostController } from '@microsoft/fast-element';
import { HTMLDirective } from '@microsoft/fast-element';
import { Orientation } from '@microsoft/fast-web-utilities';
import type { SyntheticViewTemplate } from '@microsoft/fast-element';
import type { Theme } from '@fluentui/tokens';
import { ViewTemplate } from '@microsoft/fast-element';

// @public
Expand Down Expand Up @@ -3541,6 +3540,11 @@ export const TextWeight: {
// @public
export type TextWeight = ValuesOf<typeof TextWeight>;

// Warning: (ae-internal-missing-underscore) The name "Theme" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export type Theme = Record<string, string | number>;

// @public
export class ToggleButton extends Button {
// (undocumented)
Expand Down
2 changes: 1 addition & 1 deletion packages/web-components/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ export {
TextWeight,
} from './text/index.js';
export * from './theme/design-tokens.js';
export { setTheme, setThemeFor } from './theme/index.js';
export { setTheme, setThemeFor, type Theme } from './theme/index.js';
export {
ToggleButton,
ToggleButtonAppearance,
Expand Down
2 changes: 1 addition & 1 deletion packages/web-components/src/theme/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,4 +384,4 @@ export {
shadow28Brand,
shadow64Brand,
} from './design-tokens.js';
export { setTheme, setThemeFor } from './set-theme.js';
export { setTheme, setThemeFor, type Theme } from './set-theme.js';
8 changes: 7 additions & 1 deletion packages/web-components/src/theme/set-theme.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import type { Theme } from '@fluentui/tokens';
import * as tokens from './design-tokens.js';

/**
* Not using the `Theme` type from `@fluentui/tokens` package to allow custom
* tokens to be added.
* @internal
*/
export type Theme = Record<string, string | number>;

const tokenNames = Object.keys(tokens) as (keyof Theme)[];

const SUPPORTS_REGISTER_PROPERTY = 'registerProperty' in CSS;
Expand Down