From 003ab653ebc6f39d3af7e2abd85120b428b6c6b6 Mon Sep 17 00:00:00 2001 From: metonym Date: Wed, 18 May 2022 19:28:38 -0700 Subject: [PATCH] fix(theme): use `@see` tag for link in tokens prop description (#1309) * fix(theme): use `@see` tag for link in tokens prop description * Run "yarn build:docs" --- COMPONENT_INDEX.md | 18 +++++++++--------- docs/src/COMPONENT_API.json | 2 +- src/Theme/Theme.svelte | 2 +- types/Theme/Theme.svelte.d.ts | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md index 8a78cc4c..6d4ae396 100644 --- a/COMPONENT_INDEX.md +++ b/COMPONENT_INDEX.md @@ -4142,15 +4142,15 @@ export type CarbonTheme = "white" | "g10" | "g80" | "g90" | "g100"; ### Props -| Prop name | Kind | Reactive | Type | Default value | Description | -| :--------- | :--------------- | :------- | :------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| theme | let | Yes | CarbonTheme | "white" | Set the current Carbon theme | -| tokens | let | No | { [token: string]: any; } | {} | Customize a theme with your own tokens
https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme | -| persist | let | No | boolean | false | Set to `true` to persist the theme using window.localStorage | -| persistKey | let | No | string | "theme" | Specify the local storage key | -| render | let | No | "toggle" | "select" | undefined | Render a toggle or select dropdown to control the theme | -| toggle | let | No | import("../Toggle/Toggle").ToggleProps & { themes?: [labelA: CarbonTheme, labelB: CarbonTheme]; } | { themes: ["white", "g100"], labelA: "", labelB: "", labelText: "Dark mode", hideLabel: false, } | Override the default toggle props | -| select | let | No | import("../Select/Select").SelectProps & { themes?: CarbonTheme[]; } | { themes: themeKeys, labelText: "Themes", hideLabel: false, } | Override the default select props | +| Prop name | Kind | Reactive | Type | Default value | Description | +| :--------- | :--------------- | :------- | :------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| theme | let | Yes | CarbonTheme | "white" | Set the current Carbon theme | +| tokens | let | No | { [token: string]: any; } | {} | Customize a theme with your own tokens
@see https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme | +| persist | let | No | boolean | false | Set to `true` to persist the theme using window.localStorage | +| persistKey | let | No | string | "theme" | Specify the local storage key | +| render | let | No | "toggle" | "select" | undefined | Render a toggle or select dropdown to control the theme | +| toggle | let | No | import("../Toggle/Toggle").ToggleProps & { themes?: [labelA: CarbonTheme, labelB: CarbonTheme]; } | { themes: ["white", "g100"], labelA: "", labelB: "", labelText: "Dark mode", hideLabel: false, } | Override the default toggle props | +| select | let | No | import("../Select/Select").SelectProps & { themes?: CarbonTheme[]; } | { themes: themeKeys, labelText: "Themes", hideLabel: false, } | Override the default select props | ### Slots diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json index 1aee0035..bbd39a53 100644 --- a/docs/src/COMPONENT_API.json +++ b/docs/src/COMPONENT_API.json @@ -11886,7 +11886,7 @@ { "name": "tokens", "kind": "let", - "description": "Customize a theme with your own tokens\nhttps://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme", + "description": "Customize a theme with your own tokens\n@see https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme", "type": "{ [token: string]: any; }", "value": "{}", "isFunction": false, diff --git a/src/Theme/Theme.svelte b/src/Theme/Theme.svelte index 97af924b..ee26f45d 100644 --- a/src/Theme/Theme.svelte +++ b/src/Theme/Theme.svelte @@ -18,7 +18,7 @@ /** * Customize a theme with your own tokens - * https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme + * @see https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme * @type {{ [token: string]: any; }} */ export let tokens = {}; diff --git a/types/Theme/Theme.svelte.d.ts b/types/Theme/Theme.svelte.d.ts index 343e9aa9..6dfbefbc 100644 --- a/types/Theme/Theme.svelte.d.ts +++ b/types/Theme/Theme.svelte.d.ts @@ -12,7 +12,7 @@ export interface ThemeProps { /** * Customize a theme with your own tokens - * https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme + * @see https://carbondesignsystem.com/guidelines/themes/overview#customizing-a-theme * @default {} */ tokens?: { [token: string]: any };