Repository navigation
docs(core): prop types name only types the package exports; Toast's doc marks the card's timing props required #12337
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
cixzhang
wants to merge
12
commits into
main
Choose a base branch
from
lane4/docs-name-exported-types
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+190
−87
Draft
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
c20b58a
docs(core): prop types name only types the package exports
cixzhang 03c20f5
docs(core): Toast's doc describes the card; useToast's doc gives the …
cixzhang 305b2de
docs(core): Markdown keeps MarkdownPluginEntry; Toast states what sho…
cixzhang b0a864e
docs(core): Toast's playground starts with the values show sets
cixzhang 503c1bc
docs(docsite): a SyntaxThemeDefinition prop gets the syntax theme pre…
cixzhang f245db1
docs(docsite): an optional syntax-theme row starts at None and can re…
cixzhang db93636
docs(docsite): Show code names a syntax preset by its identifier
cixzhang e015cee
Merge main into #12337
cixzhang 83a4ebc
docs(changeset): the show-only Toast options leave its props table be…
cixzhang 0db46bd
Merge main into lane4/docs-name-exported-types
cixzhang 85268d7
docs(core): Toast keeps its documented type default and native maps t…
cixzhang f8552e9
refactor(docsite): Show code names a syntax preset with the one ident…
cixzhang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| '@astryxdesign/core': patch | ||
| --- | ||
|
|
||
| [docs] Four docs name prop types the package exports. Selector's `options` are `SelectorOptionType[]` (`SelectorOption` is a component), SyntaxTheme's `theme` is a `SyntaxThemeDefinition`, and `useImperativeDialog` and `useImperativeAlertDialog` write their `show()` options with the exported Dialog and AlertDialog props. Toast's doc describes the card: `type`, `isAutoHide` and `autoHideDuration` are required there, and `useToast`'s doc lists the show options and their defaults (`uniqueID`, `collisionBehavior`, `onHide`). | ||
|
|
||
| @cixzhang | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // Copyright (c) Meta Platforms, Inc. and affiliates. | ||
|
|
||
| import {allSyntaxPresets} from '@astryxdesign/core/theme/syntax'; | ||
| import {describe, expect, it} from 'vitest'; | ||
| import { | ||
| NO_SYNTAX_THEME, | ||
| selectedSyntaxTheme, | ||
| syntaxThemeChoices, | ||
| syntaxPresetIdentifier, | ||
| syntaxThemeFor, | ||
| } from '../components/component-detail/syntaxThemeChoices'; | ||
|
|
||
| describe('the playground syntax theme control', () => { | ||
| it('shows an unset optional prop as None, and None sends nothing', () => { | ||
| expect(syntaxThemeChoices(false)[0].value).toBe(NO_SYNTAX_THEME); | ||
| expect(selectedSyntaxTheme(undefined, false)).toBe(NO_SYNTAX_THEME); | ||
| expect(syntaxThemeFor(NO_SYNTAX_THEME)).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('offers no None for a required prop, which shows the first preset', () => { | ||
| expect( | ||
| syntaxThemeChoices(true).some(choice => choice.value === NO_SYNTAX_THEME), | ||
| ).toBe(false); | ||
| expect(selectedSyntaxTheme(undefined, true)).toBe(allSyntaxPresets[0].name); | ||
| }); | ||
|
|
||
| it('shows and sends a chosen preset', () => { | ||
| const preset = allSyntaxPresets[1]; | ||
| expect(selectedSyntaxTheme(preset, false)).toBe(preset.name); | ||
| expect(syntaxThemeFor(preset.name)).toBe(preset); | ||
| }); | ||
|
|
||
| it('names a preset by its exported identifier in code', () => { | ||
| const dracula = allSyntaxPresets.find(theme => theme.name === 'dracula'); | ||
| const oneDarkPro = allSyntaxPresets.find( | ||
| theme => theme.name === 'one-dark-pro', | ||
| ); | ||
| expect(syntaxPresetIdentifier(dracula)).toBe('dracula'); | ||
| expect(syntaxPresetIdentifier(oneDarkPro)).toBe('oneDarkPro'); | ||
| expect(syntaxPresetIdentifier({name: 'dracula'})).toBeNull(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
apps/docsite/src/components/component-detail/syntaxThemeChoices.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // Copyright (c) Meta Platforms, Inc. and affiliates. | ||
|
|
||
| /** | ||
| * @file syntaxThemeChoices.ts | ||
| * @input The value of a syntax-theme prop and whether the prop is required | ||
| * @output The preset choices the playground offers, the selected choice, the | ||
| * value a choice sends, and the identifier that names a preset in code | ||
| * @position Logic of the playground's syntax-theme control | ||
| * (PlaygroundPropsTable) | ||
| */ | ||
|
|
||
| import {allSyntaxPresets} from '@astryxdesign/core/theme/syntax'; | ||
|
|
||
| /** The choice that leaves an optional syntax-theme prop unset. */ | ||
| export const NO_SYNTAX_THEME = 'None'; | ||
|
|
||
| const presets = allSyntaxPresets.map(theme => ({ | ||
| value: theme.name, | ||
| label: theme.name | ||
| .split('-') | ||
| .map(part => part.charAt(0).toUpperCase() + part.slice(1)) | ||
| .join(' '), | ||
| theme, | ||
| })); | ||
|
|
||
| /** | ||
| * The presets, with a first choice that leaves the prop unset when the prop | ||
| * is optional. An unset prop keeps the theme-level syntax colors. | ||
| */ | ||
| export function syntaxThemeChoices( | ||
| isRequired: boolean, | ||
| ): {value: string; label: string}[] { | ||
| const choices = presets.map(({value, label}) => ({value, label})); | ||
| return isRequired | ||
| ? choices | ||
| : [{value: NO_SYNTAX_THEME, label: NO_SYNTAX_THEME}, ...choices]; | ||
| } | ||
|
|
||
| /** The choice that shows `value`. */ | ||
| export function selectedSyntaxTheme( | ||
| value: unknown, | ||
| isRequired: boolean, | ||
| ): string { | ||
| const match = presets.find( | ||
| option => | ||
| option.theme === value || | ||
| (value != null && | ||
| typeof value === 'object' && | ||
| 'name' in value && | ||
| option.theme.name === value.name), | ||
| ); | ||
| if (match) { | ||
| return match.value; | ||
| } | ||
| return isRequired ? presets[0].value : NO_SYNTAX_THEME; | ||
| } | ||
|
|
||
| /** | ||
| * The identifier a preset is exported as, such as `oneDarkPro` for | ||
| * "one-dark-pro"; null when `value` is not a preset. | ||
| */ | ||
| export function syntaxPresetIdentifier(value: unknown): string | null { | ||
| const match = presets.find(option => option.theme === value); | ||
| if (!match) { | ||
| return null; | ||
| } | ||
| return match.value.replace(/-([a-z0-9])/g, (_, next: string) => | ||
|
astracat-bot[bot] marked this conversation as resolved.
Resolved
|
||
| next.toUpperCase(), | ||
| ); | ||
| } | ||
|
|
||
| /** The value a choice sends: a preset, or nothing for the unset choice. */ | ||
| export function syntaxThemeFor(choice: string): unknown { | ||
| return presets.find(option => option.value === choice)?.theme; | ||
|
astracat-bot[bot] marked this conversation as resolved.
Resolved
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.