From f571232d2ecbf3346b15074c21f18dd32d1de38a Mon Sep 17 00:00:00 2001 From: nexoscreator <112468782+nexoscreator@users.noreply.github.com> Date: Thu, 6 Feb 2025 22:31:10 +0530 Subject: [PATCH 1/4] docs(shortcuts): improve readability with tables for modifiers and shortcut keys - Converted modifier list into a structured table for better readability. - Improved clarity in descriptions of shortcut functionality. --- docs/content/1.getting-started/4.shortcuts.md | 24 +++++++++++-------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/content/1.getting-started/4.shortcuts.md b/docs/content/1.getting-started/4.shortcuts.md index 88ea16ecaa..15ca2c9aeb 100644 --- a/docs/content/1.getting-started/4.shortcuts.md +++ b/docs/content/1.getting-started/4.shortcuts.md @@ -49,18 +49,22 @@ defineShortcuts({ Shortcuts keys are written as the literal keyboard key value. Combinations are made with `_` separator. Chained shortcuts are made with `-` separator. Modifiers are also available: -- `meta`: acts as `Command` for MacOS and `Control` for others -- `ctrl`: acts as `Control` -- `shift`: acts as `Shift` and is only necessary for alphabetic keys +| Modifier | Description | +|----------|-------------| +| `meta` | Acts as `Command (⌘)` on macOS and `Control (Ctrl)` on Windows/Linux. | +| `ctrl` | Represents the `Control (Ctrl)` key across all operating systems. | +| `shift` | Represents the `Shift` key, only needed for alphabetic keys (e.g., `shift_e`). | Examples of keys: -- `escape`: will trigger by hitting `Esc` -- `meta_k`: will trigger by hitting `⌘` and `K` at the same time on MacOS, and `Ctrl` and `K` on Windows and Linux -- `ctrl_k`: will trigger by hitting `Ctrl` and `K` at the same time on MacOS, Windows and Linux -- `shift_e`: will trigger by hitting `Shift` and `E` at the same time on MacOS, Windows and Linux -- `?`: will trigger by hitting `?` on some keyboard layouts, or for example `Shift` and `/`, which results in `?` on US Mac keyboards -- `g-d`: will trigger by hitting `g` then `d` with a maximum delay of 800ms by default -- `arrowleft`: will trigger by hitting `←` (also: `arrowright`, `arrowup`, `arrowdown`) +| Shortcut Key | Action | +|---------------|--------| +| `escape` | Triggers when `Esc` is pressed | +| `meta_k` | `⌘ + K` on Mac, `Ctrl + K` on Windows/Linux | +| `ctrl_k` | Triggers `Ctrl + K` on all OS | +| `shift_e` | Triggers `Shift + E` on all OS | +| `?` | Triggers `?` (Shift + `/` on US Mac keyboards) | +| `g-d` | Triggers when `g` then `d` are pressed within 800ms | +| `arrowleft` | Triggers when `←` is pressed (also: `arrowright`, `arrowup`, `arrowdown`) | ::callout{icon="i-heroicons-light-bulb"} For a complete list of available shortcut keys, refer to the [`KeyboardEvent`](https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values) API docs. Note the `KeyboardEvent.key` has to be written in lowercase. From 18004eb201b688215f062581a382c52304e19aed Mon Sep 17 00:00:00 2001 From: nexoscreator <112468782+nexoscreator@users.noreply.github.com> Date: Thu, 6 Feb 2025 22:33:37 +0530 Subject: [PATCH 2/4] docs(theming): update theming documentation with new UI component icon configurations - Documented new `inputMenu` icons, improving selection and navigation visibility. - Added `expandButton` and `loadingState` icons for `table` component. - Included `prevButton` and `nextButton` icons for `carousel`, enhancing navigation clarity. - Updated `loadingIcon` for `toggle` component to provide better user feedback. --- docs/content/1.getting-started/3.theming.md | 24 +++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/content/1.getting-started/3.theming.md b/docs/content/1.getting-started/3.theming.md index 8ff1be46f9..072834ab1c 100644 --- a/docs/content/1.getting-started/3.theming.md +++ b/docs/content/1.getting-started/3.theming.md @@ -389,6 +389,12 @@ export default defineAppConfig({ loadingIcon: 'i-octicon-sync-24' } }, + inputMenu: { + default: { + iconselectedIcon: 'i-octicon-check-24', + trailingIcon: 'i-octicon-chevron-down-24' + } + }, select: { default: { loadingIcon: 'i-octicon-sync-24', @@ -424,6 +430,9 @@ export default defineAppConfig({ sortButton: { icon: 'i-octicon-arrow-switch-24' }, + expandButton: { + icon: 'i-octicon-chevron-down-24' + }, loadingState: { icon: 'i-octicon-sync-24' }, @@ -457,6 +466,21 @@ export default defineAppConfig({ default: { divider: 'i-octicon-chevron-right-24' } + }, + carousel: { + default: { + prevButton: { + icon: 'i-octicon-chevron-left-24' + }, + nextButton: { + icon: 'i-octicon-chevron-right-24' + } + } + }, + toggle: { + default: { + loadingIcon: 'i-octicon-sync-24' + } } } }) From 02f1cb2422ccd71384b48d4f04ad3ca309eb4a0e Mon Sep 17 00:00:00 2001 From: nexoscreator <112468782+nexoscreator@users.noreply.github.com> Date: Thu, 6 Feb 2025 22:36:08 +0530 Subject: [PATCH 3/4] docs(contributing): fix contributing guide visibility in navigation - Renamed `6.contributing.md` to `5.contributing.md` to correct ordering in the navigation. - Ensured the contributing guide appears properly in the "Getting Started" section. --- .../1.getting-started/{6.contributing.md => 5.contributing.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/content/1.getting-started/{6.contributing.md => 5.contributing.md} (100%) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/5.contributing.md similarity index 100% rename from docs/content/1.getting-started/6.contributing.md rename to docs/content/1.getting-started/5.contributing.md From 2e01107e4322343f5bc04978b2abbb8955743089 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Thu, 6 Feb 2025 21:18:33 +0100 Subject: [PATCH 4/4] Update docs/content/1.getting-started/3.theming.md --- docs/content/1.getting-started/3.theming.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/1.getting-started/3.theming.md b/docs/content/1.getting-started/3.theming.md index 072834ab1c..82f36ed419 100644 --- a/docs/content/1.getting-started/3.theming.md +++ b/docs/content/1.getting-started/3.theming.md @@ -391,7 +391,7 @@ export default defineAppConfig({ }, inputMenu: { default: { - iconselectedIcon: 'i-octicon-check-24', + selectedIcon: 'i-octicon-check-24', trailingIcon: 'i-octicon-chevron-down-24' } },