@warp-ds/elements 2.9.0-next.6 → 2.9.1-next.1
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/dist/custom-elements.json +80 -21
- package/dist/docs/affix/affix.md +24 -38
- package/dist/docs/affix/examples.md +24 -38
- package/dist/docs/alert/accessibility.md +4 -9
- package/dist/docs/alert/alert.md +24 -39
- package/dist/docs/alert/examples.md +20 -30
- package/dist/docs/attention/accessibility.md +50 -0
- package/dist/docs/attention/api.md +40 -27
- package/dist/docs/attention/attention.md +276 -27
- package/dist/docs/attention/examples.md +91 -0
- package/dist/docs/attention/usage.md +91 -0
- package/dist/docs/badge/badge.md +23 -36
- package/dist/docs/badge/examples.md +23 -36
- package/dist/docs/box/accessibility.md +29 -0
- package/dist/docs/box/api.md +16 -11
- package/dist/docs/box/box.md +189 -11
- package/dist/docs/box/examples.md +98 -0
- package/dist/docs/box/usage.md +47 -0
- package/dist/docs/textarea/accessibility.md +5 -0
- package/dist/docs/textarea/api.md +32 -47
- package/dist/docs/textarea/examples.md +81 -0
- package/dist/docs/textarea/textarea.md +133 -49
- package/dist/docs/textarea/usage.md +9 -0
- package/dist/docs/textfield/examples.md +32 -49
- package/dist/docs/textfield/textfield.md +39 -60
- package/dist/docs/textfield/usage.md +7 -11
- package/dist/index.d.ts +276 -154
- package/dist/packages/attention/attention.d.ts +46 -37
- package/dist/packages/attention/attention.js +20 -20
- package/dist/packages/attention/attention.js.map +3 -3
- package/dist/packages/box/box.d.ts +15 -14
- package/dist/packages/box/box.js +6 -6
- package/dist/packages/box/box.js.map +4 -4
- package/dist/packages/box/box.react.stories.d.ts +1 -1
- package/dist/packages/box/box.stories.d.ts +1 -0
- package/dist/packages/box/box.stories.js +12 -5
- package/dist/packages/textarea/textarea.d.ts +38 -29
- package/dist/packages/textarea/textarea.js.map +2 -2
- package/dist/web-types.json +216 -44
- package/package.json +1 -2
package/dist/index.d.ts
CHANGED
|
@@ -468,39 +468,56 @@ export type WarpButtonSolidJsProps = {
|
|
|
468
468
|
};
|
|
469
469
|
|
|
470
470
|
export type WarpAttentionProps = {
|
|
471
|
-
/**
|
|
471
|
+
/** Controls whether the attention panel is visible.
|
|
472
|
+
Set to `true` to show the attention content and `false` to hide it. */
|
|
472
473
|
show?: WarpAttention["show"];
|
|
473
|
-
/**
|
|
474
|
+
/** Preferred placement relative to the trigger element.
|
|
475
|
+
Sets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants. */
|
|
474
476
|
placement?: WarpAttention["placement"];
|
|
475
|
-
/**
|
|
477
|
+
/** Renders the component with tooltip styling and behavior.
|
|
478
|
+
Use for compact, non-modal contextual hints anchored to another element. */
|
|
476
479
|
tooltip?: WarpAttention["tooltip"];
|
|
477
|
-
/**
|
|
480
|
+
/** Renders the component as an inline callout.
|
|
481
|
+
Callout mode is used for always-in-flow informational content instead of floating overlay behavior. */
|
|
478
482
|
callout?: WarpAttention["callout"];
|
|
479
|
-
/**
|
|
483
|
+
/** Enables native popover behavior for the attention element.
|
|
484
|
+
When enabled, the component uses popover semantics and styling suitable for floating surface UI. */
|
|
480
485
|
popover?: WarpAttention["popover"];
|
|
481
|
-
/**
|
|
486
|
+
/** Renders the component with highlight styling.
|
|
487
|
+
Use highlight mode to visually emphasize important contextual information. */
|
|
482
488
|
highlight?: WarpAttention["highlight"];
|
|
483
|
-
/**
|
|
489
|
+
/** Shows a close button inside the attention component.
|
|
490
|
+
Adds an internal dismiss action that lets users close the attention panel. */
|
|
484
491
|
"can-close"?: WarpAttention["canClose"];
|
|
485
|
-
/**
|
|
492
|
+
/** Shows a close button inside the attention component.
|
|
493
|
+
Adds an internal dismiss action that lets users close the attention panel. */
|
|
486
494
|
canClose?: WarpAttention["canClose"];
|
|
487
|
-
/**
|
|
495
|
+
/** Hides the directional arrow of the attention component.
|
|
496
|
+
Disable the arrow when the visual connection to the trigger should not be shown. */
|
|
488
497
|
"no-arrow"?: WarpAttention["noArrow"];
|
|
489
|
-
/**
|
|
498
|
+
/** Hides the directional arrow of the attention component.
|
|
499
|
+
Disable the arrow when the visual connection to the trigger should not be shown. */
|
|
490
500
|
noArrow?: WarpAttention["noArrow"];
|
|
491
|
-
/**
|
|
501
|
+
/** Distance offset between trigger and attention panel.
|
|
502
|
+
Defines the main-axis spacing in pixels from the anchor element. */
|
|
492
503
|
distance?: WarpAttention["distance"];
|
|
493
|
-
/**
|
|
504
|
+
/** Cross-axis offset for fine-grained positioning.
|
|
505
|
+
Moves the panel along the cross axis in pixels to adjust alignment with the trigger. */
|
|
494
506
|
skidding?: WarpAttention["skidding"];
|
|
495
|
-
/**
|
|
507
|
+
/** Enables automatic flipping when placement has no space.
|
|
508
|
+
Allows the component to choose an alternative side if the preferred placement would overflow. */
|
|
496
509
|
flip?: WarpAttention["flip"];
|
|
497
|
-
/**
|
|
510
|
+
/** Allows overflow checks on the cross axis when flipping.
|
|
511
|
+
Use with `flip` to improve collision handling when space is constrained horizontally or vertically. */
|
|
498
512
|
"cross-axis"?: WarpAttention["crossAxis"];
|
|
499
|
-
/**
|
|
513
|
+
/** Allows overflow checks on the cross axis when flipping.
|
|
514
|
+
Use with `flip` to improve collision handling when space is constrained horizontally or vertically. */
|
|
500
515
|
crossAxis?: WarpAttention["crossAxis"];
|
|
501
|
-
/**
|
|
516
|
+
/** Ordered list of fallback placements.
|
|
517
|
+
Provides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit. */
|
|
502
518
|
"fallback-placements"?: WarpAttention["fallbackPlacements"];
|
|
503
|
-
/**
|
|
519
|
+
/** Ordered list of fallback placements.
|
|
520
|
+
Provides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit. */
|
|
504
521
|
fallbackPlacements?: WarpAttention["fallbackPlacements"];
|
|
505
522
|
/** */
|
|
506
523
|
_initialPlacement?: WarpAttention["_initialPlacement"];
|
|
@@ -509,39 +526,56 @@ export type WarpAttentionProps = {
|
|
|
509
526
|
};
|
|
510
527
|
|
|
511
528
|
export type WarpAttentionSolidJsProps = {
|
|
512
|
-
/**
|
|
529
|
+
/** Controls whether the attention panel is visible.
|
|
530
|
+
Set to `true` to show the attention content and `false` to hide it. */
|
|
513
531
|
"prop:show"?: WarpAttention["show"];
|
|
514
|
-
/**
|
|
532
|
+
/** Preferred placement relative to the trigger element.
|
|
533
|
+
Sets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants. */
|
|
515
534
|
"prop:placement"?: WarpAttention["placement"];
|
|
516
|
-
/**
|
|
535
|
+
/** Renders the component with tooltip styling and behavior.
|
|
536
|
+
Use for compact, non-modal contextual hints anchored to another element. */
|
|
517
537
|
"prop:tooltip"?: WarpAttention["tooltip"];
|
|
518
|
-
/**
|
|
538
|
+
/** Renders the component as an inline callout.
|
|
539
|
+
Callout mode is used for always-in-flow informational content instead of floating overlay behavior. */
|
|
519
540
|
"prop:callout"?: WarpAttention["callout"];
|
|
520
|
-
/**
|
|
541
|
+
/** Enables native popover behavior for the attention element.
|
|
542
|
+
When enabled, the component uses popover semantics and styling suitable for floating surface UI. */
|
|
521
543
|
"prop:popover"?: WarpAttention["popover"];
|
|
522
|
-
/**
|
|
544
|
+
/** Renders the component with highlight styling.
|
|
545
|
+
Use highlight mode to visually emphasize important contextual information. */
|
|
523
546
|
"prop:highlight"?: WarpAttention["highlight"];
|
|
524
|
-
/**
|
|
547
|
+
/** Shows a close button inside the attention component.
|
|
548
|
+
Adds an internal dismiss action that lets users close the attention panel. */
|
|
525
549
|
"bool:can-close"?: WarpAttention["canClose"];
|
|
526
|
-
/**
|
|
550
|
+
/** Shows a close button inside the attention component.
|
|
551
|
+
Adds an internal dismiss action that lets users close the attention panel. */
|
|
527
552
|
"prop:canClose"?: WarpAttention["canClose"];
|
|
528
|
-
/**
|
|
553
|
+
/** Hides the directional arrow of the attention component.
|
|
554
|
+
Disable the arrow when the visual connection to the trigger should not be shown. */
|
|
529
555
|
"bool:no-arrow"?: WarpAttention["noArrow"];
|
|
530
|
-
/**
|
|
556
|
+
/** Hides the directional arrow of the attention component.
|
|
557
|
+
Disable the arrow when the visual connection to the trigger should not be shown. */
|
|
531
558
|
"prop:noArrow"?: WarpAttention["noArrow"];
|
|
532
|
-
/**
|
|
559
|
+
/** Distance offset between trigger and attention panel.
|
|
560
|
+
Defines the main-axis spacing in pixels from the anchor element. */
|
|
533
561
|
"prop:distance"?: WarpAttention["distance"];
|
|
534
|
-
/**
|
|
562
|
+
/** Cross-axis offset for fine-grained positioning.
|
|
563
|
+
Moves the panel along the cross axis in pixels to adjust alignment with the trigger. */
|
|
535
564
|
"prop:skidding"?: WarpAttention["skidding"];
|
|
536
|
-
/**
|
|
565
|
+
/** Enables automatic flipping when placement has no space.
|
|
566
|
+
Allows the component to choose an alternative side if the preferred placement would overflow. */
|
|
537
567
|
"prop:flip"?: WarpAttention["flip"];
|
|
538
|
-
/**
|
|
568
|
+
/** Allows overflow checks on the cross axis when flipping.
|
|
569
|
+
Use with `flip` to improve collision handling when space is constrained horizontally or vertically. */
|
|
539
570
|
"bool:cross-axis"?: WarpAttention["crossAxis"];
|
|
540
|
-
/**
|
|
571
|
+
/** Allows overflow checks on the cross axis when flipping.
|
|
572
|
+
Use with `flip` to improve collision handling when space is constrained horizontally or vertically. */
|
|
541
573
|
"prop:crossAxis"?: WarpAttention["crossAxis"];
|
|
542
|
-
/**
|
|
574
|
+
/** Ordered list of fallback placements.
|
|
575
|
+
Provides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit. */
|
|
543
576
|
"attr:fallback-placements"?: WarpAttention["fallbackPlacements"];
|
|
544
|
-
/**
|
|
577
|
+
/** Ordered list of fallback placements.
|
|
578
|
+
Provides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit. */
|
|
545
579
|
"prop:fallbackPlacements"?: WarpAttention["fallbackPlacements"];
|
|
546
580
|
/** */
|
|
547
581
|
"prop:_initialPlacement"?: WarpAttention["_initialPlacement"];
|
|
@@ -582,28 +616,38 @@ Use this with a parent element that has `position: relative`. Accepted values ar
|
|
|
582
616
|
};
|
|
583
617
|
|
|
584
618
|
export type WarpBoxProps = {
|
|
585
|
-
/**
|
|
619
|
+
/** Makes the box bleed to the container edge.
|
|
620
|
+
Extends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up. */
|
|
586
621
|
bleed?: WarpBox["bleed"];
|
|
587
|
-
/**
|
|
622
|
+
/** Shows the box as a bordered surface.
|
|
623
|
+
Use this when the content needs a clear visual boundary from the surrounding page. */
|
|
588
624
|
bordered?: WarpBox["bordered"];
|
|
589
|
-
/**
|
|
625
|
+
/** Shows the box with information styling.
|
|
626
|
+
Use this for supporting informational content that should be visually separated from the surrounding page. */
|
|
590
627
|
info?: WarpBox["info"];
|
|
591
|
-
/**
|
|
628
|
+
/** Shows the box with neutral styling.
|
|
629
|
+
Use this for quiet grouped content that needs a background without strong emphasis. */
|
|
592
630
|
neutral?: WarpBox["neutral"];
|
|
593
|
-
/**
|
|
631
|
+
/** ARIA role for the box wrapper.
|
|
632
|
+
Defaults to a role of `region`. Set `role="none"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose. */
|
|
594
633
|
role?: WarpBox["role"];
|
|
595
634
|
};
|
|
596
635
|
|
|
597
636
|
export type WarpBoxSolidJsProps = {
|
|
598
|
-
/**
|
|
637
|
+
/** Makes the box bleed to the container edge.
|
|
638
|
+
Extends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up. */
|
|
599
639
|
"prop:bleed"?: WarpBox["bleed"];
|
|
600
|
-
/**
|
|
640
|
+
/** Shows the box as a bordered surface.
|
|
641
|
+
Use this when the content needs a clear visual boundary from the surrounding page. */
|
|
601
642
|
"prop:bordered"?: WarpBox["bordered"];
|
|
602
|
-
/**
|
|
643
|
+
/** Shows the box with information styling.
|
|
644
|
+
Use this for supporting informational content that should be visually separated from the surrounding page. */
|
|
603
645
|
"prop:info"?: WarpBox["info"];
|
|
604
|
-
/**
|
|
646
|
+
/** Shows the box with neutral styling.
|
|
647
|
+
Use this for quiet grouped content that needs a background without strong emphasis. */
|
|
605
648
|
"prop:neutral"?: WarpBox["neutral"];
|
|
606
|
-
/**
|
|
649
|
+
/** ARIA role for the box wrapper.
|
|
650
|
+
Defaults to a role of `region`. Set `role="none"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose. */
|
|
607
651
|
"prop:role"?: WarpBox["role"];
|
|
608
652
|
|
|
609
653
|
/** Set the innerHTML of the element */
|
|
@@ -1770,85 +1814,97 @@ export type WarpTabsSolidJsProps = {
|
|
|
1770
1814
|
};
|
|
1771
1815
|
|
|
1772
1816
|
export type WarpTextareaProps = {
|
|
1773
|
-
/**
|
|
1817
|
+
/** Keep in mind that using disabled in its current form is an anti-pattern.
|
|
1818
|
+
|
|
1819
|
+
There will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.
|
|
1820
|
+
|
|
1821
|
+
Please consider more informative alternatives before choosing to use disabled on an element. */
|
|
1774
1822
|
disabled?: WarpTextarea["disabled"];
|
|
1775
|
-
/**
|
|
1823
|
+
/** Mark the form field as invalid.
|
|
1824
|
+
|
|
1825
|
+
Make sure to also set a `help-text` to help users fix the validation problem. */
|
|
1776
1826
|
invalid?: WarpTextarea["invalid"];
|
|
1777
|
-
/**
|
|
1827
|
+
/** Either a `label` or an `aria-label` must be provided. */
|
|
1778
1828
|
label?: WarpTextarea["label"];
|
|
1779
|
-
/**
|
|
1829
|
+
/** Use in combination with `invalid` to show as a validation error message,
|
|
1830
|
+
or on its own to show a help text. */
|
|
1780
1831
|
"help-text"?: WarpTextarea["helpText"];
|
|
1781
|
-
/**
|
|
1832
|
+
/** Use in combination with `invalid` to show as a validation error message,
|
|
1833
|
+
or on its own to show a help text. */
|
|
1782
1834
|
helpText?: WarpTextarea["helpText"];
|
|
1783
|
-
/**
|
|
1835
|
+
/** Sets the maximum number of text rows before the content starts scrolling. */
|
|
1784
1836
|
"maximum-rows"?: WarpTextarea["maxRows"];
|
|
1785
|
-
/**
|
|
1837
|
+
/** Sets the maximum number of text rows before the content starts scrolling. */
|
|
1786
1838
|
maxRows?: WarpTextarea["maxRows"];
|
|
1787
|
-
/**
|
|
1839
|
+
/** Sets the minimum number of text rows the textarea should display */
|
|
1788
1840
|
"minimum-rows"?: WarpTextarea["minRows"];
|
|
1789
|
-
/**
|
|
1841
|
+
/** Sets the minimum number of text rows the textarea should display */
|
|
1790
1842
|
minRows?: WarpTextarea["minRows"];
|
|
1791
|
-
/**
|
|
1843
|
+
/** The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form */
|
|
1792
1844
|
name?: WarpTextarea["name"];
|
|
1793
|
-
/**
|
|
1845
|
+
/** Set a text that is shown in the textarea when it doesn't have a value.
|
|
1846
|
+
|
|
1847
|
+
Placeholder text should not be used as a substitute for labeling the element with a visible label. */
|
|
1794
1848
|
placeholder?: WarpTextarea["placeholder"];
|
|
1795
|
-
/** @deprecated Use the native readonly attribute instead
|
|
1849
|
+
/** @deprecated Use the native `readonly` attribute instead */
|
|
1796
1850
|
"read-only"?: WarpTextarea["readOnly"];
|
|
1797
|
-
/** @deprecated Use the native readonly attribute instead
|
|
1851
|
+
/** @deprecated Use the native `readonly` attribute instead */
|
|
1798
1852
|
readOnly?: WarpTextarea["readOnly"];
|
|
1799
|
-
/**
|
|
1853
|
+
/** Whether the input can be selected but not changed by the user */
|
|
1800
1854
|
readonly?: WarpTextarea["readonly"];
|
|
1801
|
-
/**
|
|
1855
|
+
/** Whether user input is required on the input before form submission */
|
|
1802
1856
|
required?: WarpTextarea["required"];
|
|
1803
|
-
/**
|
|
1857
|
+
/** Lets you set the current value */
|
|
1804
1858
|
value?: WarpTextarea["value"];
|
|
1805
|
-
/**
|
|
1859
|
+
/** Show an icon behind the label indicating the field is optional */
|
|
1806
1860
|
optional?: WarpTextarea["optional"];
|
|
1807
|
-
/** */
|
|
1808
|
-
minHeight?: WarpTextarea["minHeight"];
|
|
1809
|
-
/** */
|
|
1810
|
-
maxHeight?: WarpTextarea["maxHeight"];
|
|
1811
1861
|
};
|
|
1812
1862
|
|
|
1813
1863
|
export type WarpTextareaSolidJsProps = {
|
|
1814
|
-
/**
|
|
1864
|
+
/** Keep in mind that using disabled in its current form is an anti-pattern.
|
|
1865
|
+
|
|
1866
|
+
There will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.
|
|
1867
|
+
|
|
1868
|
+
Please consider more informative alternatives before choosing to use disabled on an element. */
|
|
1815
1869
|
"prop:disabled"?: WarpTextarea["disabled"];
|
|
1816
|
-
/**
|
|
1870
|
+
/** Mark the form field as invalid.
|
|
1871
|
+
|
|
1872
|
+
Make sure to also set a `help-text` to help users fix the validation problem. */
|
|
1817
1873
|
"prop:invalid"?: WarpTextarea["invalid"];
|
|
1818
|
-
/**
|
|
1874
|
+
/** Either a `label` or an `aria-label` must be provided. */
|
|
1819
1875
|
"prop:label"?: WarpTextarea["label"];
|
|
1820
|
-
/**
|
|
1876
|
+
/** Use in combination with `invalid` to show as a validation error message,
|
|
1877
|
+
or on its own to show a help text. */
|
|
1821
1878
|
"attr:help-text"?: WarpTextarea["helpText"];
|
|
1822
|
-
/**
|
|
1879
|
+
/** Use in combination with `invalid` to show as a validation error message,
|
|
1880
|
+
or on its own to show a help text. */
|
|
1823
1881
|
"prop:helpText"?: WarpTextarea["helpText"];
|
|
1824
|
-
/**
|
|
1882
|
+
/** Sets the maximum number of text rows before the content starts scrolling. */
|
|
1825
1883
|
"attr:maximum-rows"?: WarpTextarea["maxRows"];
|
|
1826
|
-
/**
|
|
1884
|
+
/** Sets the maximum number of text rows before the content starts scrolling. */
|
|
1827
1885
|
"prop:maxRows"?: WarpTextarea["maxRows"];
|
|
1828
|
-
/**
|
|
1886
|
+
/** Sets the minimum number of text rows the textarea should display */
|
|
1829
1887
|
"attr:minimum-rows"?: WarpTextarea["minRows"];
|
|
1830
|
-
/**
|
|
1888
|
+
/** Sets the minimum number of text rows the textarea should display */
|
|
1831
1889
|
"prop:minRows"?: WarpTextarea["minRows"];
|
|
1832
|
-
/**
|
|
1890
|
+
/** The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form */
|
|
1833
1891
|
"prop:name"?: WarpTextarea["name"];
|
|
1834
|
-
/**
|
|
1892
|
+
/** Set a text that is shown in the textarea when it doesn't have a value.
|
|
1893
|
+
|
|
1894
|
+
Placeholder text should not be used as a substitute for labeling the element with a visible label. */
|
|
1835
1895
|
"prop:placeholder"?: WarpTextarea["placeholder"];
|
|
1836
|
-
/** @deprecated Use the native readonly attribute instead
|
|
1896
|
+
/** @deprecated Use the native `readonly` attribute instead */
|
|
1837
1897
|
"bool:read-only"?: WarpTextarea["readOnly"];
|
|
1838
|
-
/** @deprecated Use the native readonly attribute instead
|
|
1898
|
+
/** @deprecated Use the native `readonly` attribute instead */
|
|
1839
1899
|
"prop:readOnly"?: WarpTextarea["readOnly"];
|
|
1840
|
-
/**
|
|
1900
|
+
/** Whether the input can be selected but not changed by the user */
|
|
1841
1901
|
"prop:readonly"?: WarpTextarea["readonly"];
|
|
1842
|
-
/**
|
|
1902
|
+
/** Whether user input is required on the input before form submission */
|
|
1843
1903
|
"prop:required"?: WarpTextarea["required"];
|
|
1844
|
-
/**
|
|
1904
|
+
/** Lets you set the current value */
|
|
1845
1905
|
"prop:value"?: WarpTextarea["value"];
|
|
1846
|
-
/**
|
|
1906
|
+
/** Show an icon behind the label indicating the field is optional */
|
|
1847
1907
|
"prop:optional"?: WarpTextarea["optional"];
|
|
1848
|
-
/** */
|
|
1849
|
-
"prop:minHeight"?: WarpTextarea["minHeight"];
|
|
1850
|
-
/** */
|
|
1851
|
-
"prop:maxHeight"?: WarpTextarea["maxHeight"];
|
|
1852
1908
|
|
|
1853
1909
|
/** Set the innerHTML of the element */
|
|
1854
1910
|
innerHTML?: string;
|
|
@@ -2025,25 +2081,42 @@ export type CustomElements = {
|
|
|
2025
2081
|
"w-button": Partial<WarpButtonProps & BaseProps<WarpButton> & BaseEvents>;
|
|
2026
2082
|
|
|
2027
2083
|
/**
|
|
2084
|
+
* Attention is a versatile component for displaying contextual information and messages. It can be used for a wide range of purposes, such as tooltips, callouts, popovers, and highlights.
|
|
2085
|
+
*
|
|
2086
|
+
* The component is designed to be anchored to a trigger element, providing contextual information related to that element. It supports various placements and styling options to accommodate different use cases and design needs.
|
|
2028
2087
|
*
|
|
2088
|
+
* Note: attention will soon be split into multiple components (tooltip, callout, popover, highlight) at which time this component will be deprecated. For now, use the `tooltip`, `callout`, `popover`, and `highlight` boolean properties to achieve the desired style and behavior.
|
|
2029
2089
|
*
|
|
2030
2090
|
* ## Attributes & Properties
|
|
2031
2091
|
*
|
|
2032
2092
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2033
2093
|
*
|
|
2034
|
-
* - `show`:
|
|
2035
|
-
*
|
|
2036
|
-
* - `
|
|
2037
|
-
*
|
|
2038
|
-
* - `
|
|
2039
|
-
* -
|
|
2040
|
-
* - `
|
|
2041
|
-
*
|
|
2042
|
-
* - `
|
|
2043
|
-
*
|
|
2044
|
-
* - `
|
|
2045
|
-
*
|
|
2046
|
-
* - `
|
|
2094
|
+
* - `show`: Controls whether the attention panel is visible.
|
|
2095
|
+
* Set to `true` to show the attention content and `false` to hide it.
|
|
2096
|
+
* - `placement`: Preferred placement relative to the trigger element.
|
|
2097
|
+
* Sets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants.
|
|
2098
|
+
* - `tooltip`: Renders the component with tooltip styling and behavior.
|
|
2099
|
+
* Use for compact, non-modal contextual hints anchored to another element.
|
|
2100
|
+
* - `callout`: Renders the component as an inline callout.
|
|
2101
|
+
* Callout mode is used for always-in-flow informational content instead of floating overlay behavior.
|
|
2102
|
+
* - `popover`: Enables native popover behavior for the attention element.
|
|
2103
|
+
* When enabled, the component uses popover semantics and styling suitable for floating surface UI.
|
|
2104
|
+
* - `highlight`: Renders the component with highlight styling.
|
|
2105
|
+
* Use highlight mode to visually emphasize important contextual information.
|
|
2106
|
+
* - `can-close`/`canClose`: Shows a close button inside the attention component.
|
|
2107
|
+
* Adds an internal dismiss action that lets users close the attention panel.
|
|
2108
|
+
* - `no-arrow`/`noArrow`: Hides the directional arrow of the attention component.
|
|
2109
|
+
* Disable the arrow when the visual connection to the trigger should not be shown.
|
|
2110
|
+
* - `distance`: Distance offset between trigger and attention panel.
|
|
2111
|
+
* Defines the main-axis spacing in pixels from the anchor element.
|
|
2112
|
+
* - `skidding`: Cross-axis offset for fine-grained positioning.
|
|
2113
|
+
* Moves the panel along the cross axis in pixels to adjust alignment with the trigger.
|
|
2114
|
+
* - `flip`: Enables automatic flipping when placement has no space.
|
|
2115
|
+
* Allows the component to choose an alternative side if the preferred placement would overflow.
|
|
2116
|
+
* - `cross-axis`/`crossAxis`: Allows overflow checks on the cross axis when flipping.
|
|
2117
|
+
* Use with `flip` to improve collision handling when space is constrained horizontally or vertically.
|
|
2118
|
+
* - `fallback-placements`/`fallbackPlacements`: Ordered list of fallback placements.
|
|
2119
|
+
* Provides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit.
|
|
2047
2120
|
* - `_initialPlacement`: undefined (property only)
|
|
2048
2121
|
* - `_actualDirection`: undefined (property only)
|
|
2049
2122
|
*
|
|
@@ -2093,11 +2166,16 @@ export type CustomElements = {
|
|
|
2093
2166
|
*
|
|
2094
2167
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2095
2168
|
*
|
|
2096
|
-
* - `bleed`:
|
|
2097
|
-
*
|
|
2098
|
-
* - `
|
|
2099
|
-
*
|
|
2100
|
-
* - `
|
|
2169
|
+
* - `bleed`: Makes the box bleed to the container edge.
|
|
2170
|
+
* Extends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up.
|
|
2171
|
+
* - `bordered`: Shows the box as a bordered surface.
|
|
2172
|
+
* Use this when the content needs a clear visual boundary from the surrounding page.
|
|
2173
|
+
* - `info`: Shows the box with information styling.
|
|
2174
|
+
* Use this for supporting informational content that should be visually separated from the surrounding page.
|
|
2175
|
+
* - `neutral`: Shows the box with neutral styling.
|
|
2176
|
+
* Use this for quiet grouped content that needs a background without strong emphasis.
|
|
2177
|
+
* - `role`: ARIA role for the box wrapper.
|
|
2178
|
+
* Defaults to a role of `region`. Set `role="none"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose.
|
|
2101
2179
|
*/
|
|
2102
2180
|
"w-box": Partial<WarpBoxProps & BaseProps<WarpBox> & BaseEvents>;
|
|
2103
2181
|
|
|
@@ -2804,29 +2882,40 @@ export type CustomElements = {
|
|
|
2804
2882
|
"w-tabs": Partial<WarpTabsProps & BaseProps<WarpTabs> & BaseEvents>;
|
|
2805
2883
|
|
|
2806
2884
|
/**
|
|
2807
|
-
* A
|
|
2885
|
+
* A multi-line text input with built-in form validation, auto-resizing, and styling support.
|
|
2808
2886
|
*
|
|
2809
|
-
*
|
|
2887
|
+
* The component automatically handles:
|
|
2888
|
+
* - Form integration
|
|
2889
|
+
* - Auto-resizing based on content and row constraints
|
|
2890
|
+
* - Built-in validation with customizable error messages
|
|
2891
|
+
* - Accessibility attributes and labeling
|
|
2810
2892
|
*
|
|
2811
2893
|
* ## Attributes & Properties
|
|
2812
2894
|
*
|
|
2813
2895
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
2814
2896
|
*
|
|
2815
|
-
* - `disabled`:
|
|
2816
|
-
*
|
|
2817
|
-
*
|
|
2818
|
-
*
|
|
2819
|
-
*
|
|
2820
|
-
* - `
|
|
2821
|
-
*
|
|
2822
|
-
*
|
|
2897
|
+
* - `disabled`: Keep in mind that using disabled in its current form is an anti-pattern.
|
|
2898
|
+
*
|
|
2899
|
+
* There will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.
|
|
2900
|
+
*
|
|
2901
|
+
* Please consider more informative alternatives before choosing to use disabled on an element.
|
|
2902
|
+
* - `invalid`: Mark the form field as invalid.
|
|
2903
|
+
*
|
|
2904
|
+
* Make sure to also set a `help-text` to help users fix the validation problem.
|
|
2905
|
+
* - `label`: Either a `label` or an `aria-label` must be provided.
|
|
2906
|
+
* - `help-text`/`helpText`: Use in combination with `invalid` to show as a validation error message,
|
|
2907
|
+
* or on its own to show a help text.
|
|
2908
|
+
* - `maximum-rows`/`maxRows`: Sets the maximum number of text rows before the content starts scrolling.
|
|
2909
|
+
* - `minimum-rows`/`minRows`: Sets the minimum number of text rows the textarea should display
|
|
2910
|
+
* - `name`: The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form
|
|
2911
|
+
* - `placeholder`: Set a text that is shown in the textarea when it doesn't have a value.
|
|
2912
|
+
*
|
|
2913
|
+
* Placeholder text should not be used as a substitute for labeling the element with a visible label.
|
|
2823
2914
|
* - `read-only`/`readOnly`: undefined
|
|
2824
|
-
* - `readonly`:
|
|
2825
|
-
* - `required`:
|
|
2826
|
-
* - `value`:
|
|
2827
|
-
* - `optional`:
|
|
2828
|
-
* - `minHeight`: undefined (property only)
|
|
2829
|
-
* - `maxHeight`: undefined (property only)
|
|
2915
|
+
* - `readonly`: Whether the input can be selected but not changed by the user
|
|
2916
|
+
* - `required`: Whether user input is required on the input before form submission
|
|
2917
|
+
* - `value`: Lets you set the current value
|
|
2918
|
+
* - `optional`: Show an icon behind the label indicating the field is optional
|
|
2830
2919
|
* - `validationMessage`: Returns the validation message if the textarea is invalid, otherwise an empty string (property only) (readonly)
|
|
2831
2920
|
* - `validity`: Returns the validity state of the textarea (property only) (readonly)
|
|
2832
2921
|
*
|
|
@@ -3030,25 +3119,42 @@ export type CustomElementsSolidJs = {
|
|
|
3030
3119
|
>;
|
|
3031
3120
|
|
|
3032
3121
|
/**
|
|
3122
|
+
* Attention is a versatile component for displaying contextual information and messages. It can be used for a wide range of purposes, such as tooltips, callouts, popovers, and highlights.
|
|
3033
3123
|
*
|
|
3124
|
+
* The component is designed to be anchored to a trigger element, providing contextual information related to that element. It supports various placements and styling options to accommodate different use cases and design needs.
|
|
3125
|
+
*
|
|
3126
|
+
* Note: attention will soon be split into multiple components (tooltip, callout, popover, highlight) at which time this component will be deprecated. For now, use the `tooltip`, `callout`, `popover`, and `highlight` boolean properties to achieve the desired style and behavior.
|
|
3034
3127
|
*
|
|
3035
3128
|
* ## Attributes & Properties
|
|
3036
3129
|
*
|
|
3037
3130
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3038
3131
|
*
|
|
3039
|
-
* - `show`:
|
|
3040
|
-
*
|
|
3041
|
-
* - `
|
|
3042
|
-
*
|
|
3043
|
-
* - `
|
|
3044
|
-
* -
|
|
3045
|
-
* - `
|
|
3046
|
-
*
|
|
3047
|
-
* - `
|
|
3048
|
-
*
|
|
3049
|
-
* - `
|
|
3050
|
-
*
|
|
3051
|
-
* - `
|
|
3132
|
+
* - `show`: Controls whether the attention panel is visible.
|
|
3133
|
+
* Set to `true` to show the attention content and `false` to hide it.
|
|
3134
|
+
* - `placement`: Preferred placement relative to the trigger element.
|
|
3135
|
+
* Sets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants.
|
|
3136
|
+
* - `tooltip`: Renders the component with tooltip styling and behavior.
|
|
3137
|
+
* Use for compact, non-modal contextual hints anchored to another element.
|
|
3138
|
+
* - `callout`: Renders the component as an inline callout.
|
|
3139
|
+
* Callout mode is used for always-in-flow informational content instead of floating overlay behavior.
|
|
3140
|
+
* - `popover`: Enables native popover behavior for the attention element.
|
|
3141
|
+
* When enabled, the component uses popover semantics and styling suitable for floating surface UI.
|
|
3142
|
+
* - `highlight`: Renders the component with highlight styling.
|
|
3143
|
+
* Use highlight mode to visually emphasize important contextual information.
|
|
3144
|
+
* - `can-close`/`canClose`: Shows a close button inside the attention component.
|
|
3145
|
+
* Adds an internal dismiss action that lets users close the attention panel.
|
|
3146
|
+
* - `no-arrow`/`noArrow`: Hides the directional arrow of the attention component.
|
|
3147
|
+
* Disable the arrow when the visual connection to the trigger should not be shown.
|
|
3148
|
+
* - `distance`: Distance offset between trigger and attention panel.
|
|
3149
|
+
* Defines the main-axis spacing in pixels from the anchor element.
|
|
3150
|
+
* - `skidding`: Cross-axis offset for fine-grained positioning.
|
|
3151
|
+
* Moves the panel along the cross axis in pixels to adjust alignment with the trigger.
|
|
3152
|
+
* - `flip`: Enables automatic flipping when placement has no space.
|
|
3153
|
+
* Allows the component to choose an alternative side if the preferred placement would overflow.
|
|
3154
|
+
* - `cross-axis`/`crossAxis`: Allows overflow checks on the cross axis when flipping.
|
|
3155
|
+
* Use with `flip` to improve collision handling when space is constrained horizontally or vertically.
|
|
3156
|
+
* - `fallback-placements`/`fallbackPlacements`: Ordered list of fallback placements.
|
|
3157
|
+
* Provides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit.
|
|
3052
3158
|
* - `_initialPlacement`: undefined (property only)
|
|
3053
3159
|
* - `_actualDirection`: undefined (property only)
|
|
3054
3160
|
*
|
|
@@ -3103,11 +3209,16 @@ export type CustomElementsSolidJs = {
|
|
|
3103
3209
|
*
|
|
3104
3210
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3105
3211
|
*
|
|
3106
|
-
* - `bleed`:
|
|
3107
|
-
*
|
|
3108
|
-
* - `
|
|
3109
|
-
*
|
|
3110
|
-
* - `
|
|
3212
|
+
* - `bleed`: Makes the box bleed to the container edge.
|
|
3213
|
+
* Extends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up.
|
|
3214
|
+
* - `bordered`: Shows the box as a bordered surface.
|
|
3215
|
+
* Use this when the content needs a clear visual boundary from the surrounding page.
|
|
3216
|
+
* - `info`: Shows the box with information styling.
|
|
3217
|
+
* Use this for supporting informational content that should be visually separated from the surrounding page.
|
|
3218
|
+
* - `neutral`: Shows the box with neutral styling.
|
|
3219
|
+
* Use this for quiet grouped content that needs a background without strong emphasis.
|
|
3220
|
+
* - `role`: ARIA role for the box wrapper.
|
|
3221
|
+
* Defaults to a role of `region`. Set `role="none"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose.
|
|
3111
3222
|
*/
|
|
3112
3223
|
"w-box": Partial<
|
|
3113
3224
|
WarpBoxProps & WarpBoxSolidJsProps & BaseProps<WarpBox> & BaseEvents
|
|
@@ -3886,29 +3997,40 @@ export type CustomElementsSolidJs = {
|
|
|
3886
3997
|
>;
|
|
3887
3998
|
|
|
3888
3999
|
/**
|
|
3889
|
-
* A
|
|
4000
|
+
* A multi-line text input with built-in form validation, auto-resizing, and styling support.
|
|
3890
4001
|
*
|
|
3891
|
-
*
|
|
4002
|
+
* The component automatically handles:
|
|
4003
|
+
* - Form integration
|
|
4004
|
+
* - Auto-resizing based on content and row constraints
|
|
4005
|
+
* - Built-in validation with customizable error messages
|
|
4006
|
+
* - Accessibility attributes and labeling
|
|
3892
4007
|
*
|
|
3893
4008
|
* ## Attributes & Properties
|
|
3894
4009
|
*
|
|
3895
4010
|
* Component attributes and properties that can be applied to the element or by using JavaScript.
|
|
3896
4011
|
*
|
|
3897
|
-
* - `disabled`:
|
|
3898
|
-
*
|
|
3899
|
-
*
|
|
3900
|
-
*
|
|
3901
|
-
*
|
|
3902
|
-
* - `
|
|
3903
|
-
*
|
|
3904
|
-
*
|
|
4012
|
+
* - `disabled`: Keep in mind that using disabled in its current form is an anti-pattern.
|
|
4013
|
+
*
|
|
4014
|
+
* There will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.
|
|
4015
|
+
*
|
|
4016
|
+
* Please consider more informative alternatives before choosing to use disabled on an element.
|
|
4017
|
+
* - `invalid`: Mark the form field as invalid.
|
|
4018
|
+
*
|
|
4019
|
+
* Make sure to also set a `help-text` to help users fix the validation problem.
|
|
4020
|
+
* - `label`: Either a `label` or an `aria-label` must be provided.
|
|
4021
|
+
* - `help-text`/`helpText`: Use in combination with `invalid` to show as a validation error message,
|
|
4022
|
+
* or on its own to show a help text.
|
|
4023
|
+
* - `maximum-rows`/`maxRows`: Sets the maximum number of text rows before the content starts scrolling.
|
|
4024
|
+
* - `minimum-rows`/`minRows`: Sets the minimum number of text rows the textarea should display
|
|
4025
|
+
* - `name`: The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form
|
|
4026
|
+
* - `placeholder`: Set a text that is shown in the textarea when it doesn't have a value.
|
|
4027
|
+
*
|
|
4028
|
+
* Placeholder text should not be used as a substitute for labeling the element with a visible label.
|
|
3905
4029
|
* - `read-only`/`readOnly`: undefined
|
|
3906
|
-
* - `readonly`:
|
|
3907
|
-
* - `required`:
|
|
3908
|
-
* - `value`:
|
|
3909
|
-
* - `optional`:
|
|
3910
|
-
* - `minHeight`: undefined (property only)
|
|
3911
|
-
* - `maxHeight`: undefined (property only)
|
|
4030
|
+
* - `readonly`: Whether the input can be selected but not changed by the user
|
|
4031
|
+
* - `required`: Whether user input is required on the input before form submission
|
|
4032
|
+
* - `value`: Lets you set the current value
|
|
4033
|
+
* - `optional`: Show an icon behind the label indicating the field is optional
|
|
3912
4034
|
* - `validationMessage`: Returns the validation message if the textarea is invalid, otherwise an empty string (property only) (readonly)
|
|
3913
4035
|
* - `validity`: Returns the validity state of the textarea (property only) (readonly)
|
|
3914
4036
|
*
|