Skip to content

Commit a02b9e2

Browse files
committed
fix(core): api documentation
Signed-off-by: Cory Rylan <crylan@nvidia.com>
1 parent 03c481f commit a02b9e2

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

projects/core/src/page/page-panel/page-panel.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ import globalStyles from './page-panel.global.css?inline';
2121
* @documentation https://nvidia.github.io/elements/docs/elements/page/
2222
* @entrypoint \@nvidia-elements/core/page
2323
* @since 1.15.0
24-
* @event open
25-
* @event close
24+
* @event open - Dispatched after an invoker command removes `hidden` and opens the panel.
25+
* @event close - Dispatched after an invoker command sets `hidden` and closes the panel.
2626
* @slot - default content slot
2727
* @slot actions - slot for action / dismiss buttons
28-
* @command --open - use to open the panel
29-
* @command --close - use to close the panel
30-
* @command --toggle - use to toggle the panel
28+
* @command --open - Removes `hidden` and dispatches `open`.
29+
* @command --close - Sets `hidden` and dispatches `close`.
30+
* @command --toggle - Toggles `hidden` and dispatches `open` or `close`.
3131
* @cssprop --background
3232
* @cssprop --border
3333
* @cssprop --color

projects/core/src/sort-button/sort-button.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ const nextSort = {
2020
* @documentation https://nvidia.github.io/elements/docs/elements/sort-button/
2121
* @since 0.11.0
2222
* @entrypoint \@nvidia-elements/core/sort-button
23-
* @event sort - Dispatched on sort button click, returns the current sort value and the next sort value.
23+
* @event sort - Dispatched on activation with `detail: { value, next }`, where `value` is the current sort and `next` follows the cycle `none` → `ascending` → `descending` → `none`.
2424
* @cssprop --width
2525
* @cssprop --height
2626
* @cssprop --border-radius

0 commit comments

Comments
 (0)