le-kit 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LLM_CONTEXT.md +122 -1
- package/package.json +1 -1
package/LLM_CONTEXT.md
CHANGED
|
@@ -4,6 +4,7 @@ This file is auto-generated and contains documentation for all Le-Kit web compon
|
|
|
4
4
|
|
|
5
5
|
## Table of Contents
|
|
6
6
|
|
|
7
|
+
- [le-actions-sequence](#le-actions-sequence)
|
|
7
8
|
- [le-bar](#le-bar)
|
|
8
9
|
- [le-bento-grid](#le-bento-grid)
|
|
9
10
|
- [le-bento-tile](#le-bento-tile)
|
|
@@ -17,7 +18,9 @@ This file is auto-generated and contains documentation for all Le-Kit web compon
|
|
|
17
18
|
- [le-collapse](#le-collapse)
|
|
18
19
|
- [le-combobox](#le-combobox)
|
|
19
20
|
- [le-component](#le-component)
|
|
21
|
+
- [le-context-menu](#le-context-menu)
|
|
20
22
|
- [le-current-heading](#le-current-heading)
|
|
23
|
+
- [le-drag-handle](#le-drag-handle)
|
|
21
24
|
- [le-dropdown-base](#le-dropdown-base)
|
|
22
25
|
- [le-header](#le-header)
|
|
23
26
|
- [le-header-placeholder](#le-header-placeholder)
|
|
@@ -54,6 +57,36 @@ This file is auto-generated and contains documentation for all Le-Kit web compon
|
|
|
54
57
|
|
|
55
58
|
---
|
|
56
59
|
|
|
60
|
+
## <le-actions-sequence>
|
|
61
|
+
|
|
62
|
+
A non-visual component that runs a sequence of timed actions on its children.
|
|
63
|
+
Designed for creating automated interaction loops and interactive demos.
|
|
64
|
+
|
|
65
|
+
### Properties
|
|
66
|
+
|
|
67
|
+
| Name | Type | Default | Description |
|
|
68
|
+
|------|------|---------|-------------|
|
|
69
|
+
| `el` | `HTMLElement` | | |
|
|
70
|
+
| `steps` | `ActionStep[] \| string` | `[]` | Array of ActionStep objects or a JSON string representation. |
|
|
71
|
+
| `startOn` | `'init' \| 'in-view' \| 'manual'` | `'init'` | Playback triggers: 'init' (starts immediately), 'in-view' (scrolled into viewport), 'manual'. |
|
|
72
|
+
| `inViewThreshold` | `number` | `0.5` | Visibility threshold ratio (0.0 to 1.0) before triggering in-view. |
|
|
73
|
+
| `loop` | `boolean` | `false` | Repeat the sequence when finished. |
|
|
74
|
+
| `loopDelay` | `number` | `0` | Loop delay in milliseconds before restarting the sequence. |
|
|
75
|
+
| `direction` | `'forward' \| 'reverse' \| 'alternate'` | `'forward'` | Playback direction. |
|
|
76
|
+
| `debug` | `boolean` | `false` | Output debug logs to console. |
|
|
77
|
+
| `pauseOnHover` | `boolean` | `false` | Pause the sequence when the user hovers over the element. Resumes on mouseleave. |
|
|
78
|
+
| `pauseOnInteraction` | `boolean` | `false` | Pause the sequence when the user interacts (click/focus/drag) inside the element. |
|
|
79
|
+
|
|
80
|
+
### Events
|
|
81
|
+
|
|
82
|
+
| Event | Type | Description |
|
|
83
|
+
|-------|------|-------------|
|
|
84
|
+
| `leStart` | `EventEmitter<void>` | Emitted when the sequence starts playing |
|
|
85
|
+
| `leStep` | `EventEmitter<{ index: number; step: ActionStep; target: HTMLElement }>` | Emitted when a step starts executing |
|
|
86
|
+
| `leFinish` | `EventEmitter<void>` | Emitted when the sequence finishes |
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
57
90
|
## <le-bar>
|
|
58
91
|
|
|
59
92
|
A flexible bar component that handles overflow gracefully.
|
|
@@ -259,6 +292,7 @@ A flexible button component with multiple variants and states.
|
|
|
259
292
|
\| 'transparent' \| undefined` | | Button color theme (uses theme semantic colors) |
|
|
260
293
|
| `size` | `'small' \| 'medium' \| 'large'` | `'medium'` | Button size |
|
|
261
294
|
| `selected` | `boolean` | `false` | Whether the button is in a selected/active state |
|
|
295
|
+
| `value` | `string \| undefined` | | The value associated with the button (useful when in a button group) |
|
|
262
296
|
| `label` | `string \| undefined` | | Optional label for the button, used for accessibility and tooltips when the button is icon-only. |
|
|
263
297
|
| `tooltip` | `string \| undefined` | | Tooltip text to show on hover |
|
|
264
298
|
| `tooltipPosition` | `TooltipPlacement` | `'top'` | Tooltip position around the button |
|
|
@@ -268,7 +302,14 @@ A flexible button component with multiple variants and states.
|
|
|
268
302
|
| `motionPreset` | `'none' \| 'soft' \| 'fluid' \| 'spring' \| undefined` | | Optional per-instance motion preset override. |
|
|
269
303
|
| `iconOnly` | `string \| Node \| undefined` | | Icon only button image or emoji if this prop is set, the button will render only the icon slot |
|
|
270
304
|
| `iconStart` | `string \| Node \| undefined` | | Start icon image or emoji |
|
|
305
|
+
| `iconCount` | `number \| undefined` | | Notification count for shorthand icons. Applies to start icon, or icon-only if set. |
|
|
306
|
+
| `iconStartCount` | `number \| undefined` | | Count specifically for iconStart. |
|
|
307
|
+
| `collapsible` | `boolean` | `false` | Enables responsive collapse to icon-only when the toolbar applies `collapse="icon"`. |
|
|
308
|
+
| `collapse` | `string \| undefined` | | Runtime collapse state controlled by responsive containers. |
|
|
309
|
+
| `collapsePriorityOffset` | `number` | `100` | Relative collapse priority offset for toolbar stepping. Higher numbers collapse earlier while keeping the button visible longer. |
|
|
271
310
|
| `iconEnd` | `string \| Node \| undefined` | | End icon image or emoji |
|
|
311
|
+
| `iconEndCount` | `number \| undefined` | | Count specifically for iconEnd. |
|
|
312
|
+
| `iconOnlyCount` | `number \| undefined` | | Count specifically for iconOnly. |
|
|
272
313
|
| `disabled` | `boolean` | `false` | Whether the button is disabled |
|
|
273
314
|
| `type` | `'button' \| 'submit' \| 'reset'` | `'button'` | The button type attribute |
|
|
274
315
|
| `href` | `string \| undefined` | | Optional href to make the button act as a link |
|
|
@@ -287,6 +328,8 @@ A flexible button component with multiple variants and states.
|
|
|
287
328
|
|------|-------------|
|
|
288
329
|
| Default | Button text content |
|
|
289
330
|
| `"icon-only"` | Icon for icon-only buttons |
|
|
331
|
+
| `"icon-start"` | Icon placed in the beginning of the button |
|
|
332
|
+
| `"icon-end"` | Icon placed in the end of the button |
|
|
290
333
|
|
|
291
334
|
### CSS Variables
|
|
292
335
|
|
|
@@ -315,12 +358,15 @@ into an overflow "more" menu.
|
|
|
315
358
|
| `overflowIcons` | `boolean` | `false` | When true, icons from collapsed buttons are shown in the overflow navigation list. |
|
|
316
359
|
| `disabled` | `boolean` | `false` | Disabled attribute, when the button group is disabled, all buttons inside will be disabled and the overflow menu will not be accessible. |
|
|
317
360
|
| `visibility` | `'visible' \| 'collapsing' \| 'collapsed' \| 'expanding'` | `'visible'` | Visibility state used by responsive containers such as le-toolbar. |
|
|
361
|
+
| `type` | `'radio' \| 'checkbox' \| undefined` | | Selection type: radio (single select) or checkbox (multi select) |
|
|
362
|
+
| `value` | `string \| string[] \| undefined` | | Selected value(s). If type is 'radio', value is a string. If type is 'checkbox', value is a string or string[]. |
|
|
318
363
|
|
|
319
364
|
### Events
|
|
320
365
|
|
|
321
366
|
| Event | Type | Description |
|
|
322
367
|
|-------|------|-------------|
|
|
323
368
|
| `leOverflowSelect` | `EventEmitter<{ id: string }>` | |
|
|
369
|
+
| `leChange` | `EventEmitter<LeOptionSelectDetail \| LeMultiOptionSelectDetail>` | |
|
|
324
370
|
|
|
325
371
|
### Slots
|
|
326
372
|
|
|
@@ -570,6 +616,39 @@ render() {
|
|
|
570
616
|
|
|
571
617
|
---
|
|
572
618
|
|
|
619
|
+
## <le-context-menu>
|
|
620
|
+
|
|
621
|
+
Context menu component that displays a vertical navigation menu
|
|
622
|
+
when the user right-clicks or long-presses on its children.
|
|
623
|
+
|
|
624
|
+
### Properties
|
|
625
|
+
|
|
626
|
+
| Name | Type | Default | Description |
|
|
627
|
+
|------|------|---------|-------------|
|
|
628
|
+
| `el` | `HTMLElement` | | |
|
|
629
|
+
| `open` | `boolean` | `false` | Whether the context menu is open. |
|
|
630
|
+
| `disabled` | `boolean` | `false` | Disables right-click and touch interactions. |
|
|
631
|
+
| `items` | `LeOption[] \| string` | `[]` | List of menu items represented as options. |
|
|
632
|
+
| `backdrop` | `boolean` | `false` | Whether to show a backdrop behind the menu, lifting the active item. |
|
|
633
|
+
| `pageScrollBehavior` | `'blocked' \| 'menu-close' \| 'fixed-menu'` | `'menu-close'` | Behavior of the menu on page scroll: - 'blocked': blocks page scroll - 'menu-close': closes the menu automatically on scroll (default) - 'fixed-menu': menu scrolls with the page |
|
|
634
|
+
| `position` | `'top' \| 'bottom' \| 'left' \| 'right' \| 'mouse'` | `'mouse'` | Position of the menu relative to the trigger. If 'mouse', positions next to mouse/touch coords. |
|
|
635
|
+
| `align` | `'start' \| 'center' \| 'end'` | `'start'` | Alignment of the menu relative to the trigger. |
|
|
636
|
+
|
|
637
|
+
### Events
|
|
638
|
+
|
|
639
|
+
| Event | Type | Description |
|
|
640
|
+
|-------|------|-------------|
|
|
641
|
+
| `leContextMenuSelect` | `EventEmitter<LeContextMenuSelectDetail>` | Emitted when a menu item is selected. |
|
|
642
|
+
| `leContextMenuClose` | `EventEmitter<void>` | Emitted when the context menu is closed. |
|
|
643
|
+
|
|
644
|
+
### Slots
|
|
645
|
+
|
|
646
|
+
| Name | Description |
|
|
647
|
+
|------|-------------|
|
|
648
|
+
| Default | Trigger content |
|
|
649
|
+
|
|
650
|
+
---
|
|
651
|
+
|
|
573
652
|
## <le-current-heading>
|
|
574
653
|
|
|
575
654
|
Shows a "smart" header title based on what has scrolled out of view.
|
|
@@ -592,6 +671,25 @@ When `selector` matches multiple elements, the title becomes the last element
|
|
|
592
671
|
|
|
593
672
|
---
|
|
594
673
|
|
|
674
|
+
## <le-drag-handle>
|
|
675
|
+
|
|
676
|
+
Reusable drag handle used by resizable components.
|
|
677
|
+
|
|
678
|
+
### Properties
|
|
679
|
+
|
|
680
|
+
| Name | Type | Default | Description |
|
|
681
|
+
|------|------|---------|-------------|
|
|
682
|
+
| `orientation` | `LeDragHandleOrientation` | `'vertical'` | Handle orientation (vertical = width drag, horizontal = height drag). |
|
|
683
|
+
| `placement` | `LeDragHandlePlacement` | `'end'` | Handle position on the owning edge. |
|
|
684
|
+
|
|
685
|
+
### Slots
|
|
686
|
+
|
|
687
|
+
| Name | Description |
|
|
688
|
+
|------|-------------|
|
|
689
|
+
| Default | Optional assistive text for screen readers. |
|
|
690
|
+
|
|
691
|
+
---
|
|
692
|
+
|
|
595
693
|
## <le-dropdown-base>
|
|
596
694
|
|
|
597
695
|
Internal dropdown base component that provides shared functionality
|
|
@@ -731,6 +829,24 @@ The header component updates that variable when it renders.
|
|
|
731
829
|
| `el` | `HTMLElement` | | |
|
|
732
830
|
| `name` | `string \| undefined` | `undefined` | Name of the icon to display. Corresponds to a JSON file in the assets folder. For example, "search" will load the "search.json" file. |
|
|
733
831
|
| `size` | `number` | `16` | Size of the icon in pixels. Default is 16. |
|
|
832
|
+
| `viewBox` | `string \| undefined` | | Custom viewBox for the SVG. When set, overrides the viewBox from the loaded icon data. Useful for layer-only compositions without a base icon. |
|
|
833
|
+
| `badge` | `string \| undefined` | | Name of a badge icon to overlay on top of the base icon. The badge icon is loaded and composed with mask-based knockout. |
|
|
834
|
+
| `badgePosition` | `string \| undefined` | | Position of the badge icon within the base icon's viewBox. Comma-separated x,y values in viewBox units or percentages. Positive values = from start/top, Negative values = from end/bottom. Percentages work like CSS background-position. Default: "-5, -5" (bottom-right area). |
|
|
835
|
+
| `badgeScale` | `number \| undefined` | | Scale factor for the badge icon. Default: 1.0. Badge icons are designed at their natural display size, so 1.0 means no scaling. Use >1 to enlarge, <1 to shrink. |
|
|
836
|
+
| `badgeOpacity` | `number \| undefined` | | Optional opacity for the badge icon (0 to 1). |
|
|
837
|
+
| `count` | `number \| undefined` | | Optional numeric count for notification badge (e.g. 5 or 120). |
|
|
838
|
+
| `maxCount` | `number \| undefined` | | Optional max count threshold (e.g. 99 -> "99+"). |
|
|
839
|
+
| `badgeText` | `string \| boolean \| undefined` | | Optional text string for notification badge (e.g. "NEW"). Can also be set as boolean attribute `<le-icon badge-text></le-icon>` for an empty dot. |
|
|
840
|
+
| `dot` | `boolean \| undefined` | | Whether to display an empty circle dot badge. |
|
|
841
|
+
| `badgeTextColor` | `string \| undefined` | | Optional text/font color for the badge text. |
|
|
842
|
+
| `badgeColor` | `string \| undefined` | | Optional color for the badge icon or background (CSS color or variable). Defaults to 'transparent'. |
|
|
843
|
+
| `baseColor` | `string \| undefined` | | Optional color for the base icon (CSS color or variable). |
|
|
844
|
+
| `layers` | `string \| undefined` | | JSON string defining additional icon layers to compose on top of the base icon. Each layer has a name, optional position, and optional scale. Layers are rendered in order (first = bottom, last = top), and each layer's maskShape (if present) cuts through all layers below it. |
|
|
845
|
+
| `rounded` | `boolean \| undefined` | | Whether to use rounded variants of icon elements if defined in icon JSON. If not explicitly set, defaults to the global le-kit config (`icons.defaultRounded`). |
|
|
846
|
+
| `sharp` | `boolean \| undefined` | | Whether to force sharp (non-rounded) variants of icon elements. Overrides `rounded` prop, registry settings, and global defaults. |
|
|
847
|
+
| `filled` | `boolean \| undefined` | | Whether to use filled variants of icon elements if defined in icon JSON. If not explicitly set, defaults to the global le-kit config (`icons.defaultFilled`). |
|
|
848
|
+
| `outlined` | `boolean \| undefined` | | Whether to force outlined (non-filled) variants of icon elements. Overrides `filled` prop, registry settings, and global defaults. |
|
|
849
|
+
| `thin` | `boolean \| undefined` | | Whether to use thin variants of icon elements if defined in icon JSON. If not explicitly set, defaults to the global le-kit config (`icons.defaultThin`). |
|
|
734
850
|
|
|
735
851
|
---
|
|
736
852
|
|
|
@@ -825,6 +941,7 @@ Navigation component with vertical (tree) and horizontal (menu) layouts.
|
|
|
825
941
|
| `emptyText` | `string` | `'No results found'` | Text shown when no items match the filter. |
|
|
826
942
|
| `submenuSearchable` | `boolean` | `false` | Whether submenu popovers should include a filter input. |
|
|
827
943
|
| `activationMode` | `LeNavigationActivationMode` | `'manual'` | Whether keyboard focus only highlights, or also activates immediately. |
|
|
944
|
+
| `autoScroll` | `boolean` | `false` | Automatically scroll the active item into view when the active URL changes or on initial load. - Initial load: instant (no animation) - Subsequent `activeUrl` changes: smooth Only applies to `vertical` orientation. |
|
|
828
945
|
| `togglePosition` | `'start' \| 'end'` | `'start'` | Position of the toggle arrow for items with children: 'start' | 'end' |
|
|
829
946
|
|
|
830
947
|
### Events
|
|
@@ -1035,7 +1152,8 @@ component demos and documentation.
|
|
|
1035
1152
|
| `frameWidth` | `number \| undefined` | | Initial inner width of the preview viewport in pixels. Set to 0 or 'auto' to fill the available container width. |
|
|
1036
1153
|
| `minWidth` | `number` | `240` | Minimum resizable width in pixels. |
|
|
1037
1154
|
| `maxWidth` | `number` | `0` | Maximum resizable width in pixels. 0 = unconstrained. |
|
|
1038
|
-
| `showControls` | `boolean` | `
|
|
1155
|
+
| `showControls` | `boolean \| 'none' \| 'width' \| 'breakpoints' \| 'all'` | `'all'` | What controls to show in the toolbar. - none: hide the entire controls bar - width: show only the width badge - breakpoints: show only the breakpoint preset buttons - all: show both the buttons and the width badge |
|
|
1156
|
+
| `showFrame` | `'no' \| 'hover' \| 'always'` | `'always'` | Visibility strategy for the preview frame border, background, and controls. - always: Frame controls and borders are always visible. - hover: Invisible by default, fades in on hover or focus-within. - no: Always invisible (only viewport content is visible). |
|
|
1039
1157
|
| `resizable` | `boolean` | `true` | Whether to show drag resize handles. |
|
|
1040
1158
|
| `handles` | `LePreviewFrameHandleSide[] \| string` | `'right'` | Which handles are rendered. Accepts "right", "left", "bottom", "left,right", etc. or a JSON string/array. |
|
|
1041
1159
|
| `origin` | `LePreviewFrameResizeOrigin` | `'auto'` | Horizontal resize origin strategy. - auto: detects centered layouts and switches to center math - edge: keeps opposite edge fixed (default left-aligned behavior) - center: grows/shrinks from center |
|
|
@@ -1183,8 +1301,11 @@ A select dropdown component for single selection.
|
|
|
1183
1301
|
| `collapseAt` | `string \| undefined` | | Width breakpoint (in px or a CSS var like `--le-breakpoint-md`) below which the panel enters "narrow" mode. |
|
|
1184
1302
|
| `narrowBehavior` | `LeSidePanelNarrowBehavior` | `'overlay'` | Behavior when in narrow mode. |
|
|
1185
1303
|
| `sticky` | `boolean` | `false` | Whether the panel is sticky (remains visible when scrolling). |
|
|
1304
|
+
| `minPanelHeight` | `number` | `200` | Minimum panel height (px) when sticky full-height logic is active. |
|
|
1186
1305
|
| `top` | `number \| 'under-header'` | `0` | Top offset for the sticky panel. |
|
|
1306
|
+
| `bottom` | `number \| 'under-footer'` | `0` | Bottom offset for sticky full-height calculations. |
|
|
1187
1307
|
| `fullHeight` | `boolean` | `false` | Whether the sticky panel should stretch to full height. |
|
|
1308
|
+
| `margin` | `string \| number \| undefined` | | Optional panel margin override. Accepts CSS length (e.g. `16px`, `1rem`, `var(--space-4)`). |
|
|
1188
1309
|
| `open` | `boolean` | `false` | Panel open state for narrow mode. - overlay: controls modal drawer visibility - push: controls whether panel is shown (non-modal) |
|
|
1189
1310
|
| `collapsed` | `boolean` | `false` | Panel collapsed state for wide mode (fully hidden). |
|
|
1190
1311
|
| `panelWidth` | `number` | `280` | Default panel width in pixels. |
|