@synergy-design-system/components 1.8.0 → 1.10.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/dist/chunks/{chunk.23HTU3YE.js → chunk.2EI3TNL7.js} +1 -16
- package/dist/chunks/chunk.2EI3TNL7.js.map +7 -0
- package/dist/chunks/{chunk.RSONAU45.js → chunk.2RF7KO5I.js} +1 -12
- package/dist/chunks/chunk.2RF7KO5I.js.map +7 -0
- package/dist/chunks/{chunk.CUU2VBEZ.js → chunk.2ZSYEFTP.js} +2 -2
- package/dist/chunks/{chunk.5TFG753C.js → chunk.3B2AQAU2.js} +2 -2
- package/dist/chunks/{chunk.G66TSLVT.js → chunk.3DUJKCD2.js} +23 -13
- package/dist/chunks/chunk.3DUJKCD2.js.map +7 -0
- package/dist/chunks/{chunk.HW5TASOL.js → chunk.3RA2P64H.js} +3 -3
- package/dist/chunks/{chunk.4CBN5LPQ.js → chunk.3STW62TA.js} +1 -12
- package/dist/chunks/chunk.3STW62TA.js.map +7 -0
- package/dist/chunks/{chunk.EKOK7YPB.js → chunk.4QS5IWYB.js} +1 -16
- package/dist/chunks/chunk.4QS5IWYB.js.map +7 -0
- package/dist/chunks/{chunk.KA7L2PMA.js → chunk.67GSZBK7.js} +20 -13
- package/dist/chunks/chunk.67GSZBK7.js.map +7 -0
- package/dist/chunks/{chunk.UG5FC6UD.js → chunk.7HMAYWNS.js} +2 -2
- package/dist/chunks/{chunk.6PWB7EUW.js → chunk.7N42OBRZ.js} +2 -2
- package/dist/chunks/{chunk.JRXQK6LG.js → chunk.7UVCYUNR.js} +2 -2
- package/dist/chunks/{chunk.4ZURABYO.js → chunk.A7IIJ2LL.js} +1 -7
- package/dist/chunks/{chunk.O7USYXBT.js.map → chunk.A7IIJ2LL.js.map} +3 -3
- package/dist/chunks/{chunk.PGCXJ2PT.js → chunk.ACTJFDNK.js} +1 -12
- package/dist/chunks/chunk.ACTJFDNK.js.map +7 -0
- package/dist/chunks/{chunk.MNMITYTH.js → chunk.ADRKUQGR.js} +1 -12
- package/dist/chunks/chunk.ADRKUQGR.js.map +7 -0
- package/dist/chunks/{chunk.RS4Z4KDT.js → chunk.AYTANJEE.js} +10 -6
- package/dist/chunks/chunk.AYTANJEE.js.map +7 -0
- package/dist/chunks/{chunk.4ZGN7AEC.js → chunk.BF2Z2XBN.js} +18 -10
- package/dist/chunks/chunk.BF2Z2XBN.js.map +7 -0
- package/dist/chunks/{chunk.QHFGD6WW.js → chunk.BGHK4NQA.js} +1 -12
- package/dist/chunks/chunk.BGHK4NQA.js.map +7 -0
- package/dist/chunks/{chunk.2IBWQADW.js → chunk.BI7J7YNX.js} +2 -2
- package/dist/chunks/{chunk.F3YEAZYJ.js → chunk.BOO4VTHX.js} +2 -2
- package/dist/chunks/{chunk.HNRD7DBS.js → chunk.CBR46SD4.js} +6 -5
- package/dist/chunks/chunk.CBR46SD4.js.map +7 -0
- package/dist/chunks/{chunk.W6V7TPGK.js → chunk.CFIQXXMW.js} +1 -12
- package/dist/chunks/chunk.CFIQXXMW.js.map +7 -0
- package/dist/chunks/chunk.CJZHKDBQ.js +12 -0
- package/dist/chunks/chunk.CJZHKDBQ.js.map +7 -0
- package/dist/chunks/{chunk.DAROCSFO.js → chunk.DIXHBM5G.js} +10 -6
- package/dist/chunks/chunk.DIXHBM5G.js.map +7 -0
- package/dist/chunks/{chunk.WP6T5CG2.js → chunk.FAKWK5NS.js} +2 -2
- package/dist/chunks/{chunk.UVYPEAQZ.js → chunk.GQY3KJDK.js} +23 -8
- package/dist/chunks/chunk.GQY3KJDK.js.map +7 -0
- package/dist/chunks/{chunk.2KKPNUPU.js → chunk.GTSRMEPE.js} +2 -4
- package/dist/chunks/chunk.GTSRMEPE.js.map +7 -0
- package/dist/chunks/{chunk.MRAXEK5D.js → chunk.H5ZKCFYO.js} +2 -2
- package/dist/chunks/{chunk.JBHQJWOB.js → chunk.HELY6MCO.js} +71 -33
- package/dist/chunks/chunk.HELY6MCO.js.map +7 -0
- package/dist/chunks/{chunk.NWWHBSV7.js → chunk.HUHPPFDX.js} +2 -2
- package/dist/chunks/chunk.JDXKGJ63.js +99 -0
- package/dist/chunks/chunk.JDXKGJ63.js.map +7 -0
- package/dist/chunks/chunk.JMP6V7XJ.js +80 -0
- package/dist/chunks/chunk.JMP6V7XJ.js.map +7 -0
- package/dist/chunks/{chunk.K4ELZCXB.js → chunk.JORZ3DML.js} +2 -2
- package/dist/chunks/{chunk.JSO3PKB4.js → chunk.KUO3KJOC.js} +2 -2
- package/dist/chunks/{chunk.A2WGLZOL.js → chunk.LIRQO322.js} +2 -2
- package/dist/chunks/{chunk.2FN5DTS6.js → chunk.LJQ7LEPV.js} +1 -12
- package/dist/chunks/chunk.LJQ7LEPV.js.map +7 -0
- package/dist/chunks/{chunk.COKV3ZN7.js → chunk.M6D7QVXC.js} +2 -2
- package/dist/chunks/{chunk.JN7CLMQZ.js → chunk.MIMALEWP.js} +21 -7
- package/dist/chunks/chunk.MIMALEWP.js.map +7 -0
- package/dist/chunks/{chunk.Y4QKFZLK.js → chunk.MZBIDOMW.js} +84 -46
- package/dist/chunks/chunk.MZBIDOMW.js.map +7 -0
- package/dist/chunks/{chunk.5AAIHRMI.js → chunk.N4VSEIRQ.js} +3 -1
- package/dist/chunks/{chunk.5AAIHRMI.js.map → chunk.N4VSEIRQ.js.map} +2 -2
- package/dist/chunks/{chunk.35PHCFSV.js → chunk.NII3J5OF.js} +12 -8
- package/dist/chunks/chunk.NII3J5OF.js.map +7 -0
- package/dist/chunks/{chunk.NAAFLDZ3.js → chunk.OPP7D6NX.js} +2 -2
- package/dist/chunks/{chunk.N2I6HVX3.js → chunk.OSBC36KQ.js} +4 -9
- package/dist/chunks/chunk.OSBC36KQ.js.map +7 -0
- package/dist/chunks/{chunk.NV7W5R6V.js → chunk.PHSJD47V.js} +1 -12
- package/dist/chunks/chunk.PHSJD47V.js.map +7 -0
- package/dist/chunks/{chunk.JBYBQ5TQ.js → chunk.PKO6FEOM.js} +1 -12
- package/dist/chunks/chunk.PKO6FEOM.js.map +7 -0
- package/dist/chunks/{chunk.GZVDP7WZ.js → chunk.QF4AQCX3.js} +137 -42
- package/dist/chunks/chunk.QF4AQCX3.js.map +7 -0
- package/dist/chunks/{chunk.6XU6OLZ3.js → chunk.QNQNR3RY.js} +1 -16
- package/dist/chunks/chunk.QNQNR3RY.js.map +7 -0
- package/dist/chunks/{chunk.XI6MSNHF.js → chunk.QRXBA3TE.js} +83 -5
- package/dist/chunks/chunk.QRXBA3TE.js.map +7 -0
- package/dist/chunks/{chunk.B75SET3J.js → chunk.RRQEMHEV.js} +6 -5
- package/dist/chunks/chunk.RRQEMHEV.js.map +7 -0
- package/dist/chunks/{chunk.ERNEIORV.js → chunk.SHI4PSGX.js} +9 -5
- package/dist/chunks/chunk.SHI4PSGX.js.map +7 -0
- package/dist/chunks/{chunk.OJ4KOC7R.js → chunk.SJMMPKWP.js} +1 -12
- package/dist/chunks/chunk.SJMMPKWP.js.map +7 -0
- package/dist/chunks/{chunk.2Z2GYRLO.js → chunk.SZCGMXW5.js} +2 -2
- package/dist/chunks/chunk.SZCGMXW5.js.map +7 -0
- package/dist/chunks/{chunk.MB3YZTYP.js → chunk.TGVTAWOV.js} +6 -5
- package/dist/chunks/chunk.TGVTAWOV.js.map +7 -0
- package/dist/chunks/{chunk.JHXCBOUD.js → chunk.TTL762VF.js} +57 -60
- package/dist/chunks/chunk.TTL762VF.js.map +7 -0
- package/dist/chunks/{chunk.OJUBVHIK.js → chunk.UCMAXFGL.js} +2 -2
- package/dist/chunks/{chunk.2XCLA4MQ.js → chunk.UX22QVVR.js} +2 -2
- package/dist/chunks/{chunk.RVFNEWM3.js → chunk.UXDU44Q3.js} +2 -2
- package/dist/chunks/{chunk.AFEABUNX.js → chunk.W5JK7V7K.js} +6 -1
- package/dist/chunks/chunk.W5JK7V7K.js.map +7 -0
- package/dist/chunks/{chunk.BGPAHVPK.js → chunk.WEX3I4KA.js} +2 -2
- package/dist/chunks/{chunk.GUQN6XL4.js → chunk.WUFFQJJF.js} +10 -6
- package/dist/chunks/chunk.WUFFQJJF.js.map +7 -0
- package/dist/chunks/{chunk.4I6M5V6O.js → chunk.XIUSSERX.js} +1 -16
- package/dist/chunks/chunk.XIUSSERX.js.map +7 -0
- package/dist/chunks/{chunk.WDX7XUUK.js → chunk.XVNL6NRN.js} +22 -2
- package/dist/chunks/chunk.XVNL6NRN.js.map +7 -0
- package/dist/chunks/{chunk.AWZ4FSAL.js → chunk.YDMQ766U.js} +15 -11
- package/dist/chunks/chunk.YDMQ766U.js.map +7 -0
- package/dist/chunks/{chunk.AJWDVZRI.js → chunk.ZGFM7UKE.js} +45 -19
- package/dist/chunks/chunk.ZGFM7UKE.js.map +7 -0
- package/dist/chunks/{chunk.IKKMWFWH.js → chunk.ZIQXX272.js} +2 -2
- package/dist/components/button/button.component.js +12 -13
- package/dist/components/button/button.js +13 -14
- package/dist/components/button/button.styles.js +1 -3
- package/dist/components/button-group/button-group.component.js +3 -4
- package/dist/components/button-group/button-group.js +4 -5
- package/dist/components/button-group/button-group.styles.js +1 -2
- package/dist/components/checkbox/checkbox.component.d.ts +5 -0
- package/dist/components/checkbox/checkbox.component.js +11 -10
- package/dist/components/checkbox/checkbox.js +12 -11
- package/dist/components/checkbox/checkbox.styles.js +1 -3
- package/dist/components/divider/divider.component.js +3 -4
- package/dist/components/divider/divider.js +4 -5
- package/dist/components/divider/divider.styles.js +1 -3
- package/dist/components/drawer/drawer.component.d.ts +1 -0
- package/dist/components/drawer/drawer.component.js +12 -13
- package/dist/components/drawer/drawer.js +13 -14
- package/dist/components/drawer/drawer.styles.js +1 -3
- package/dist/components/header/header.component.d.ts +36 -0
- package/dist/components/header/header.component.js +20 -0
- package/dist/components/header/header.component.js.map +7 -0
- package/dist/components/header/header.d.ts +8 -0
- package/dist/components/header/header.js +21 -0
- package/dist/components/header/header.js.map +7 -0
- package/dist/components/header/header.styles.d.ts +2 -0
- package/dist/components/header/header.styles.js +8 -0
- package/dist/components/header/header.styles.js.map +7 -0
- package/dist/components/icon/icon.component.js +6 -7
- package/dist/components/icon/icon.js +7 -8
- package/dist/components/icon/icon.styles.js +1 -3
- package/dist/components/icon/library.js +2 -2
- package/dist/components/icon/library.system.js +1 -1
- package/dist/components/icon-button/icon-button.component.js +8 -9
- package/dist/components/icon-button/icon-button.js +9 -10
- package/dist/components/icon-button/icon-button.styles.js +1 -3
- package/dist/components/input/input.component.js +13 -14
- package/dist/components/input/input.js +14 -15
- package/dist/components/input/input.styles.js +1 -4
- package/dist/components/optgroup/optgroup.component.js +4 -5
- package/dist/components/optgroup/optgroup.js +5 -6
- package/dist/components/option/option.component.js +8 -9
- package/dist/components/option/option.js +9 -10
- package/dist/components/option/option.styles.js +1 -3
- package/dist/components/popup/popup.component.d.ts +9 -0
- package/dist/components/popup/popup.component.js +3 -4
- package/dist/components/popup/popup.styles.js +1 -2
- package/dist/components/radio/radio.component.js +8 -9
- package/dist/components/radio/radio.js +9 -10
- package/dist/components/radio/radio.styles.js +1 -3
- package/dist/components/radio-button/radio-button.component.js +4 -6
- package/dist/components/radio-button/radio-button.js +5 -7
- package/dist/components/radio-button/radio-button.styles.js +2 -4
- package/dist/components/radio-group/radio-group.component.d.ts +1 -0
- package/dist/components/radio-group/radio-group.component.js +7 -8
- package/dist/components/radio-group/radio-group.js +8 -9
- package/dist/components/radio-group/radio-group.styles.js +1 -4
- package/dist/components/select/select.component.d.ts +1 -0
- package/dist/components/select/select.component.js +18 -19
- package/dist/components/select/select.js +19 -20
- package/dist/components/select/select.styles.js +1 -4
- package/dist/components/spinner/spinner.component.js +3 -4
- package/dist/components/spinner/spinner.styles.js +1 -2
- package/dist/components/switch/switch.component.d.ts +5 -0
- package/dist/components/switch/switch.component.js +7 -6
- package/dist/components/switch/switch.custom.styles.js +1 -1
- package/dist/components/switch/switch.js +8 -7
- package/dist/components/switch/switch.styles.js +1 -3
- package/dist/components/tag/tag.component.js +10 -11
- package/dist/components/tag/tag.js +11 -12
- package/dist/components/tag/tag.styles.js +1 -3
- package/dist/components/textarea/textarea.component.js +5 -6
- package/dist/components/textarea/textarea.js +6 -7
- package/dist/components/textarea/textarea.styles.js +1 -4
- package/dist/custom-elements.json +379 -147
- package/dist/internal/longpress.d.ts +2 -2
- package/dist/internal/modal.d.ts +3 -0
- package/dist/synergy.d.ts +1 -0
- package/dist/synergy.js +84 -79
- package/dist/utilities/form.js +2 -2
- package/dist/utilities/icon-library.js +2 -2
- package/dist/vscode.html-custom-data.json +53 -21
- package/package.json +2 -4
- package/dist/chunks/chunk.23HTU3YE.js.map +0 -7
- package/dist/chunks/chunk.2FN5DTS6.js.map +0 -7
- package/dist/chunks/chunk.2KKPNUPU.js.map +0 -7
- package/dist/chunks/chunk.2Z2GYRLO.js.map +0 -7
- package/dist/chunks/chunk.35PHCFSV.js.map +0 -7
- package/dist/chunks/chunk.4CBN5LPQ.js.map +0 -7
- package/dist/chunks/chunk.4I6M5V6O.js.map +0 -7
- package/dist/chunks/chunk.4ZGN7AEC.js.map +0 -7
- package/dist/chunks/chunk.4ZURABYO.js.map +0 -7
- package/dist/chunks/chunk.6XU6OLZ3.js.map +0 -7
- package/dist/chunks/chunk.AFEABUNX.js.map +0 -7
- package/dist/chunks/chunk.AJWDVZRI.js.map +0 -7
- package/dist/chunks/chunk.AWZ4FSAL.js.map +0 -7
- package/dist/chunks/chunk.B75SET3J.js.map +0 -7
- package/dist/chunks/chunk.DAROCSFO.js.map +0 -7
- package/dist/chunks/chunk.EKOK7YPB.js.map +0 -7
- package/dist/chunks/chunk.ERNEIORV.js.map +0 -7
- package/dist/chunks/chunk.G66TSLVT.js.map +0 -7
- package/dist/chunks/chunk.GUQN6XL4.js.map +0 -7
- package/dist/chunks/chunk.GZVDP7WZ.js.map +0 -7
- package/dist/chunks/chunk.HNRD7DBS.js.map +0 -7
- package/dist/chunks/chunk.JBHQJWOB.js.map +0 -7
- package/dist/chunks/chunk.JBYBQ5TQ.js.map +0 -7
- package/dist/chunks/chunk.JHXCBOUD.js.map +0 -7
- package/dist/chunks/chunk.JN7CLMQZ.js.map +0 -7
- package/dist/chunks/chunk.KA7L2PMA.js.map +0 -7
- package/dist/chunks/chunk.MB3YZTYP.js.map +0 -7
- package/dist/chunks/chunk.MNMITYTH.js.map +0 -7
- package/dist/chunks/chunk.N2I6HVX3.js.map +0 -7
- package/dist/chunks/chunk.NV7W5R6V.js.map +0 -7
- package/dist/chunks/chunk.O7USYXBT.js +0 -23
- package/dist/chunks/chunk.OJ4KOC7R.js.map +0 -7
- package/dist/chunks/chunk.PGCXJ2PT.js.map +0 -7
- package/dist/chunks/chunk.QHFGD6WW.js.map +0 -7
- package/dist/chunks/chunk.RS4Z4KDT.js.map +0 -7
- package/dist/chunks/chunk.RSONAU45.js.map +0 -7
- package/dist/chunks/chunk.UVYPEAQZ.js.map +0 -7
- package/dist/chunks/chunk.W6V7TPGK.js.map +0 -7
- package/dist/chunks/chunk.WDX7XUUK.js.map +0 -7
- package/dist/chunks/chunk.XI6MSNHF.js.map +0 -7
- package/dist/chunks/chunk.Y4QKFZLK.js.map +0 -7
- package/dist/web-types.json +0 -2580
- /package/dist/chunks/{chunk.CUU2VBEZ.js.map → chunk.2ZSYEFTP.js.map} +0 -0
- /package/dist/chunks/{chunk.5TFG753C.js.map → chunk.3B2AQAU2.js.map} +0 -0
- /package/dist/chunks/{chunk.HW5TASOL.js.map → chunk.3RA2P64H.js.map} +0 -0
- /package/dist/chunks/{chunk.UG5FC6UD.js.map → chunk.7HMAYWNS.js.map} +0 -0
- /package/dist/chunks/{chunk.6PWB7EUW.js.map → chunk.7N42OBRZ.js.map} +0 -0
- /package/dist/chunks/{chunk.JRXQK6LG.js.map → chunk.7UVCYUNR.js.map} +0 -0
- /package/dist/chunks/{chunk.2IBWQADW.js.map → chunk.BI7J7YNX.js.map} +0 -0
- /package/dist/chunks/{chunk.F3YEAZYJ.js.map → chunk.BOO4VTHX.js.map} +0 -0
- /package/dist/chunks/{chunk.WP6T5CG2.js.map → chunk.FAKWK5NS.js.map} +0 -0
- /package/dist/chunks/{chunk.MRAXEK5D.js.map → chunk.H5ZKCFYO.js.map} +0 -0
- /package/dist/chunks/{chunk.NWWHBSV7.js.map → chunk.HUHPPFDX.js.map} +0 -0
- /package/dist/chunks/{chunk.K4ELZCXB.js.map → chunk.JORZ3DML.js.map} +0 -0
- /package/dist/chunks/{chunk.JSO3PKB4.js.map → chunk.KUO3KJOC.js.map} +0 -0
- /package/dist/chunks/{chunk.A2WGLZOL.js.map → chunk.LIRQO322.js.map} +0 -0
- /package/dist/chunks/{chunk.COKV3ZN7.js.map → chunk.M6D7QVXC.js.map} +0 -0
- /package/dist/chunks/{chunk.NAAFLDZ3.js.map → chunk.OPP7D6NX.js.map} +0 -0
- /package/dist/chunks/{chunk.OJUBVHIK.js.map → chunk.UCMAXFGL.js.map} +0 -0
- /package/dist/chunks/{chunk.2XCLA4MQ.js.map → chunk.UX22QVVR.js.map} +0 -0
- /package/dist/chunks/{chunk.RVFNEWM3.js.map → chunk.UXDU44Q3.js.map} +0 -0
- /package/dist/chunks/{chunk.BGPAHVPK.js.map → chunk.WEX3I4KA.js.map} +0 -0
- /package/dist/chunks/{chunk.IKKMWFWH.js.map → chunk.ZIQXX272.js.map} +0 -0
package/dist/web-types.json
DELETED
|
@@ -1,2580 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
|
-
"name": "@synergy-design-system/components",
|
|
4
|
-
"version": "1.8.0",
|
|
5
|
-
"description-markup": "markdown",
|
|
6
|
-
"contributions": {
|
|
7
|
-
"html": {
|
|
8
|
-
"elements": [
|
|
9
|
-
{
|
|
10
|
-
"name": "syn-button",
|
|
11
|
-
"description": "Buttons represent actions that are available to the user.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the button loses focus.\n- **syn-focus** - Emitted when the button gains focus.\n- **syn-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the button.\n- **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The button's label.\n- **prefix** - A presentational prefix icon or similar element.\n- **suffix** - A presentational suffix icon or similar element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **prefix** - The container that wraps the prefix.\n- **label** - The button's label.\n- **suffix** - The container that wraps the suffix.\n- **caret** - The button's caret icon, an `<syn-icon>` element.\n- **spinner** - The spinner that shows when the button is in the loading state.",
|
|
12
|
-
"doc-url": "",
|
|
13
|
-
"attributes": [
|
|
14
|
-
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
|
15
|
-
{
|
|
16
|
-
"name": "variant",
|
|
17
|
-
"description": "The button's theme variant.",
|
|
18
|
-
"value": {
|
|
19
|
-
"type": "'filled' | 'outline' | 'text'",
|
|
20
|
-
"default": "'outline'"
|
|
21
|
-
}
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"name": "size",
|
|
25
|
-
"description": "The button's size.",
|
|
26
|
-
"value": {
|
|
27
|
-
"type": "'small' | 'medium' | 'large'",
|
|
28
|
-
"default": "'medium'"
|
|
29
|
-
}
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"name": "caret",
|
|
33
|
-
"description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
|
|
34
|
-
"value": { "type": "boolean", "default": "false" }
|
|
35
|
-
},
|
|
36
|
-
{
|
|
37
|
-
"name": "disabled",
|
|
38
|
-
"description": "Disables the button.",
|
|
39
|
-
"value": { "type": "boolean", "default": "false" }
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
"name": "loading",
|
|
43
|
-
"description": "Draws the button in a loading state.",
|
|
44
|
-
"value": { "type": "boolean", "default": "false" }
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"name": "type",
|
|
48
|
-
"description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
|
|
49
|
-
"value": {
|
|
50
|
-
"type": "'button' | 'submit' | 'reset'",
|
|
51
|
-
"default": "'button'"
|
|
52
|
-
}
|
|
53
|
-
},
|
|
54
|
-
{
|
|
55
|
-
"name": "name",
|
|
56
|
-
"description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
|
|
57
|
-
"value": { "type": "string", "default": "''" }
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
"name": "value",
|
|
61
|
-
"description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
|
|
62
|
-
"value": { "type": "string", "default": "''" }
|
|
63
|
-
},
|
|
64
|
-
{
|
|
65
|
-
"name": "href",
|
|
66
|
-
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
|
67
|
-
"value": { "type": "string", "default": "''" }
|
|
68
|
-
},
|
|
69
|
-
{
|
|
70
|
-
"name": "target",
|
|
71
|
-
"description": "Tells the browser where to open the link. Only used when `href` is present.",
|
|
72
|
-
"value": { "type": "'_blank' | '_parent' | '_self' | '_top'" }
|
|
73
|
-
},
|
|
74
|
-
{
|
|
75
|
-
"name": "rel",
|
|
76
|
-
"description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
|
|
77
|
-
"value": { "type": "string", "default": "'noreferrer noopener'" }
|
|
78
|
-
},
|
|
79
|
-
{
|
|
80
|
-
"name": "download",
|
|
81
|
-
"description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
|
|
82
|
-
"value": { "type": "string | undefined" }
|
|
83
|
-
},
|
|
84
|
-
{
|
|
85
|
-
"name": "form",
|
|
86
|
-
"description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
|
|
87
|
-
"value": { "type": "string" }
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
"name": "formaction",
|
|
91
|
-
"description": "Used to override the form owner's `action` attribute.",
|
|
92
|
-
"value": { "type": "string" }
|
|
93
|
-
},
|
|
94
|
-
{
|
|
95
|
-
"name": "formenctype",
|
|
96
|
-
"description": "Used to override the form owner's `enctype` attribute.",
|
|
97
|
-
"value": {
|
|
98
|
-
"type": "'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'"
|
|
99
|
-
}
|
|
100
|
-
},
|
|
101
|
-
{
|
|
102
|
-
"name": "formmethod",
|
|
103
|
-
"description": "Used to override the form owner's `method` attribute.",
|
|
104
|
-
"value": { "type": "'post' | 'get'" }
|
|
105
|
-
},
|
|
106
|
-
{
|
|
107
|
-
"name": "formnovalidate",
|
|
108
|
-
"description": "Used to override the form owner's `novalidate` attribute.",
|
|
109
|
-
"value": { "type": "boolean" }
|
|
110
|
-
},
|
|
111
|
-
{
|
|
112
|
-
"name": "formtarget",
|
|
113
|
-
"description": "Used to override the form owner's `target` attribute.",
|
|
114
|
-
"value": {
|
|
115
|
-
"type": "'_self' | '_blank' | '_parent' | '_top' | string"
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
],
|
|
119
|
-
"slots": [
|
|
120
|
-
{ "name": "", "description": "The button's label." },
|
|
121
|
-
{
|
|
122
|
-
"name": "prefix",
|
|
123
|
-
"description": "A presentational prefix icon or similar element."
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
"name": "suffix",
|
|
127
|
-
"description": "A presentational suffix icon or similar element."
|
|
128
|
-
}
|
|
129
|
-
],
|
|
130
|
-
"events": [
|
|
131
|
-
{
|
|
132
|
-
"name": "syn-blur",
|
|
133
|
-
"description": "Emitted when the button loses focus."
|
|
134
|
-
},
|
|
135
|
-
{
|
|
136
|
-
"name": "syn-focus",
|
|
137
|
-
"description": "Emitted when the button gains focus."
|
|
138
|
-
},
|
|
139
|
-
{
|
|
140
|
-
"name": "syn-invalid",
|
|
141
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
142
|
-
}
|
|
143
|
-
],
|
|
144
|
-
"js": {
|
|
145
|
-
"properties": [
|
|
146
|
-
{ "name": "title", "value": { "type": "string" } },
|
|
147
|
-
{
|
|
148
|
-
"name": "variant",
|
|
149
|
-
"description": "The button's theme variant.",
|
|
150
|
-
"value": { "type": "'filled' | 'outline' | 'text'" }
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"name": "size",
|
|
154
|
-
"description": "The button's size.",
|
|
155
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
156
|
-
},
|
|
157
|
-
{
|
|
158
|
-
"name": "caret",
|
|
159
|
-
"description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
|
|
160
|
-
"value": { "type": "boolean" }
|
|
161
|
-
},
|
|
162
|
-
{
|
|
163
|
-
"name": "disabled",
|
|
164
|
-
"description": "Disables the button.",
|
|
165
|
-
"value": { "type": "boolean" }
|
|
166
|
-
},
|
|
167
|
-
{
|
|
168
|
-
"name": "loading",
|
|
169
|
-
"description": "Draws the button in a loading state.",
|
|
170
|
-
"value": { "type": "boolean" }
|
|
171
|
-
},
|
|
172
|
-
{
|
|
173
|
-
"name": "type",
|
|
174
|
-
"description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
|
|
175
|
-
"value": { "type": "'button' | 'submit' | 'reset'" }
|
|
176
|
-
},
|
|
177
|
-
{
|
|
178
|
-
"name": "name",
|
|
179
|
-
"description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
|
|
180
|
-
"value": { "type": "string" }
|
|
181
|
-
},
|
|
182
|
-
{
|
|
183
|
-
"name": "value",
|
|
184
|
-
"description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
|
|
185
|
-
"value": { "type": "string" }
|
|
186
|
-
},
|
|
187
|
-
{
|
|
188
|
-
"name": "href",
|
|
189
|
-
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
|
190
|
-
"value": { "type": "string" }
|
|
191
|
-
},
|
|
192
|
-
{
|
|
193
|
-
"name": "target",
|
|
194
|
-
"description": "Tells the browser where to open the link. Only used when `href` is present.",
|
|
195
|
-
"value": { "type": "'_blank' | '_parent' | '_self' | '_top'" }
|
|
196
|
-
},
|
|
197
|
-
{
|
|
198
|
-
"name": "rel",
|
|
199
|
-
"description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
|
|
200
|
-
"value": { "type": "string" }
|
|
201
|
-
},
|
|
202
|
-
{
|
|
203
|
-
"name": "download",
|
|
204
|
-
"description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
|
|
205
|
-
"value": { "type": "string | undefined" }
|
|
206
|
-
},
|
|
207
|
-
{
|
|
208
|
-
"name": "form",
|
|
209
|
-
"description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
|
|
210
|
-
"value": { "type": "string" }
|
|
211
|
-
},
|
|
212
|
-
{
|
|
213
|
-
"name": "formaction",
|
|
214
|
-
"description": "Used to override the form owner's `action` attribute.",
|
|
215
|
-
"value": { "type": "string" }
|
|
216
|
-
},
|
|
217
|
-
{
|
|
218
|
-
"name": "formenctype",
|
|
219
|
-
"description": "Used to override the form owner's `enctype` attribute.",
|
|
220
|
-
"value": {
|
|
221
|
-
"type": "'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'"
|
|
222
|
-
}
|
|
223
|
-
},
|
|
224
|
-
{
|
|
225
|
-
"name": "formmethod",
|
|
226
|
-
"description": "Used to override the form owner's `method` attribute.",
|
|
227
|
-
"value": { "type": "'post' | 'get'" }
|
|
228
|
-
},
|
|
229
|
-
{
|
|
230
|
-
"name": "formnovalidate",
|
|
231
|
-
"description": "Used to override the form owner's `novalidate` attribute.",
|
|
232
|
-
"value": { "type": "boolean" }
|
|
233
|
-
},
|
|
234
|
-
{
|
|
235
|
-
"name": "formtarget",
|
|
236
|
-
"description": "Used to override the form owner's `target` attribute.",
|
|
237
|
-
"value": {
|
|
238
|
-
"type": "'_self' | '_blank' | '_parent' | '_top' | string"
|
|
239
|
-
}
|
|
240
|
-
}
|
|
241
|
-
],
|
|
242
|
-
"events": [
|
|
243
|
-
{
|
|
244
|
-
"name": "syn-blur",
|
|
245
|
-
"description": "Emitted when the button loses focus."
|
|
246
|
-
},
|
|
247
|
-
{
|
|
248
|
-
"name": "syn-focus",
|
|
249
|
-
"description": "Emitted when the button gains focus."
|
|
250
|
-
},
|
|
251
|
-
{
|
|
252
|
-
"name": "syn-invalid",
|
|
253
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
254
|
-
}
|
|
255
|
-
]
|
|
256
|
-
}
|
|
257
|
-
},
|
|
258
|
-
{
|
|
259
|
-
"name": "syn-button-group",
|
|
260
|
-
"description": "Button groups can be used to group related buttons into sections.\n---\n\n\n### **Slots:**\n - _default_ - One or more `<syn-button>` elements to display in the button group.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
261
|
-
"doc-url": "",
|
|
262
|
-
"attributes": [
|
|
263
|
-
{
|
|
264
|
-
"name": "label",
|
|
265
|
-
"description": "A label to use for the button group. This won't be displayed on the screen, but it will be announced by assistive\ndevices when interacting with the control and is strongly recommended.",
|
|
266
|
-
"value": { "type": "string", "default": "''" }
|
|
267
|
-
}
|
|
268
|
-
],
|
|
269
|
-
"slots": [
|
|
270
|
-
{
|
|
271
|
-
"name": "",
|
|
272
|
-
"description": "One or more `<syn-button>` elements to display in the button group."
|
|
273
|
-
}
|
|
274
|
-
],
|
|
275
|
-
"events": [],
|
|
276
|
-
"js": {
|
|
277
|
-
"properties": [
|
|
278
|
-
{
|
|
279
|
-
"name": "label",
|
|
280
|
-
"description": "A label to use for the button group. This won't be displayed on the screen, but it will be announced by assistive\ndevices when interacting with the control and is strongly recommended.",
|
|
281
|
-
"value": { "type": "string" }
|
|
282
|
-
}
|
|
283
|
-
],
|
|
284
|
-
"events": []
|
|
285
|
-
}
|
|
286
|
-
},
|
|
287
|
-
{
|
|
288
|
-
"name": "syn-checkbox",
|
|
289
|
-
"description": "Checkboxes allow the user to toggle an option on or off.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the checkbox loses focus.\n- **syn-change** - Emitted when the checked state changes.\n- **syn-focus** - Emitted when the checkbox gains focus.\n- **syn-input** - Emitted when the checkbox receives input.\n- **syn-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the checkbox.\n- **focus(options: _FocusOptions_)** - Sets focus on the checkbox.\n- **blur()** - Removes focus from the checkbox.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. The value provided will be shown to the user when the form is submitted. To clear\nthe custom validation message, call this method with an empty string.\n\n### **Slots:**\n - _default_ - The checkbox's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The square container that wraps the checkbox's checked state.\n- **control--checked** - Matches the control part when the checkbox is checked.\n- **control--indeterminate** - Matches the control part when the checkbox is indeterminate.\n- **checked-icon** - The checked icon, an `<syn-icon>` element.\n- **indeterminate-icon** - The indeterminate icon, an `<syn-icon>` element.\n- **label** - The container that wraps the checkbox's label.",
|
|
290
|
-
"doc-url": "",
|
|
291
|
-
"attributes": [
|
|
292
|
-
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
|
293
|
-
{
|
|
294
|
-
"name": "name",
|
|
295
|
-
"description": "The name of the checkbox, submitted as a name/value pair with form data.",
|
|
296
|
-
"value": { "type": "string", "default": "''" }
|
|
297
|
-
},
|
|
298
|
-
{
|
|
299
|
-
"name": "value",
|
|
300
|
-
"description": "The current value of the checkbox, submitted as a name/value pair with form data.",
|
|
301
|
-
"value": { "type": "string" }
|
|
302
|
-
},
|
|
303
|
-
{
|
|
304
|
-
"name": "size",
|
|
305
|
-
"description": "The checkbox's size.",
|
|
306
|
-
"value": {
|
|
307
|
-
"type": "'small' | 'medium' | 'large'",
|
|
308
|
-
"default": "'medium'"
|
|
309
|
-
}
|
|
310
|
-
},
|
|
311
|
-
{
|
|
312
|
-
"name": "disabled",
|
|
313
|
-
"description": "Disables the checkbox.",
|
|
314
|
-
"value": { "type": "boolean", "default": "false" }
|
|
315
|
-
},
|
|
316
|
-
{
|
|
317
|
-
"name": "checked",
|
|
318
|
-
"description": "Draws the checkbox in a checked state.",
|
|
319
|
-
"value": { "type": "boolean", "default": "false" }
|
|
320
|
-
},
|
|
321
|
-
{
|
|
322
|
-
"name": "indeterminate",
|
|
323
|
-
"description": "Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a \"select\nall/none\" behavior when associated checkboxes have a mix of checked and unchecked states.",
|
|
324
|
-
"value": { "type": "boolean", "default": "false" }
|
|
325
|
-
},
|
|
326
|
-
{
|
|
327
|
-
"name": "form",
|
|
328
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
329
|
-
"value": { "type": "string", "default": "''" }
|
|
330
|
-
},
|
|
331
|
-
{
|
|
332
|
-
"name": "required",
|
|
333
|
-
"description": "Makes the checkbox a required field.",
|
|
334
|
-
"value": { "type": "boolean", "default": "false" }
|
|
335
|
-
}
|
|
336
|
-
],
|
|
337
|
-
"slots": [{ "name": "", "description": "The checkbox's label." }],
|
|
338
|
-
"events": [
|
|
339
|
-
{
|
|
340
|
-
"name": "syn-blur",
|
|
341
|
-
"description": "Emitted when the checkbox loses focus."
|
|
342
|
-
},
|
|
343
|
-
{
|
|
344
|
-
"name": "syn-change",
|
|
345
|
-
"description": "Emitted when the checked state changes."
|
|
346
|
-
},
|
|
347
|
-
{
|
|
348
|
-
"name": "syn-focus",
|
|
349
|
-
"description": "Emitted when the checkbox gains focus."
|
|
350
|
-
},
|
|
351
|
-
{
|
|
352
|
-
"name": "syn-input",
|
|
353
|
-
"description": "Emitted when the checkbox receives input."
|
|
354
|
-
},
|
|
355
|
-
{
|
|
356
|
-
"name": "syn-invalid",
|
|
357
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
358
|
-
}
|
|
359
|
-
],
|
|
360
|
-
"js": {
|
|
361
|
-
"properties": [
|
|
362
|
-
{ "name": "title", "value": { "type": "string" } },
|
|
363
|
-
{
|
|
364
|
-
"name": "name",
|
|
365
|
-
"description": "The name of the checkbox, submitted as a name/value pair with form data.",
|
|
366
|
-
"value": { "type": "string" }
|
|
367
|
-
},
|
|
368
|
-
{
|
|
369
|
-
"name": "value",
|
|
370
|
-
"description": "The current value of the checkbox, submitted as a name/value pair with form data.",
|
|
371
|
-
"value": { "type": "string" }
|
|
372
|
-
},
|
|
373
|
-
{
|
|
374
|
-
"name": "size",
|
|
375
|
-
"description": "The checkbox's size.",
|
|
376
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
377
|
-
},
|
|
378
|
-
{
|
|
379
|
-
"name": "disabled",
|
|
380
|
-
"description": "Disables the checkbox.",
|
|
381
|
-
"value": { "type": "boolean" }
|
|
382
|
-
},
|
|
383
|
-
{
|
|
384
|
-
"name": "checked",
|
|
385
|
-
"description": "Draws the checkbox in a checked state.",
|
|
386
|
-
"value": { "type": "boolean" }
|
|
387
|
-
},
|
|
388
|
-
{
|
|
389
|
-
"name": "indeterminate",
|
|
390
|
-
"description": "Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a \"select\nall/none\" behavior when associated checkboxes have a mix of checked and unchecked states.",
|
|
391
|
-
"value": { "type": "boolean" }
|
|
392
|
-
},
|
|
393
|
-
{
|
|
394
|
-
"name": "form",
|
|
395
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
396
|
-
"value": { "type": "string" }
|
|
397
|
-
},
|
|
398
|
-
{
|
|
399
|
-
"name": "required",
|
|
400
|
-
"description": "Makes the checkbox a required field.",
|
|
401
|
-
"value": { "type": "boolean" }
|
|
402
|
-
}
|
|
403
|
-
],
|
|
404
|
-
"events": [
|
|
405
|
-
{
|
|
406
|
-
"name": "syn-blur",
|
|
407
|
-
"description": "Emitted when the checkbox loses focus."
|
|
408
|
-
},
|
|
409
|
-
{
|
|
410
|
-
"name": "syn-change",
|
|
411
|
-
"description": "Emitted when the checked state changes."
|
|
412
|
-
},
|
|
413
|
-
{
|
|
414
|
-
"name": "syn-focus",
|
|
415
|
-
"description": "Emitted when the checkbox gains focus."
|
|
416
|
-
},
|
|
417
|
-
{
|
|
418
|
-
"name": "syn-input",
|
|
419
|
-
"description": "Emitted when the checkbox receives input."
|
|
420
|
-
},
|
|
421
|
-
{
|
|
422
|
-
"name": "syn-invalid",
|
|
423
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
424
|
-
}
|
|
425
|
-
]
|
|
426
|
-
}
|
|
427
|
-
},
|
|
428
|
-
{
|
|
429
|
-
"name": "syn-divider",
|
|
430
|
-
"description": "Dividers are used to visually separate or group elements.\n---\n\n\n### **CSS Properties:**\n - **--color** - The color of the divider. _(default: undefined)_\n- **--width** - The width of the divider. _(default: undefined)_\n- **--spacing** - The spacing of the divider. _(default: undefined)_",
|
|
431
|
-
"doc-url": "",
|
|
432
|
-
"attributes": [
|
|
433
|
-
{
|
|
434
|
-
"name": "vertical",
|
|
435
|
-
"description": "Draws the divider in a vertical orientation.",
|
|
436
|
-
"value": { "type": "boolean", "default": "false" }
|
|
437
|
-
}
|
|
438
|
-
],
|
|
439
|
-
"events": [],
|
|
440
|
-
"js": {
|
|
441
|
-
"properties": [
|
|
442
|
-
{
|
|
443
|
-
"name": "vertical",
|
|
444
|
-
"description": "Draws the divider in a vertical orientation.",
|
|
445
|
-
"value": { "type": "boolean" }
|
|
446
|
-
}
|
|
447
|
-
],
|
|
448
|
-
"events": []
|
|
449
|
-
}
|
|
450
|
-
},
|
|
451
|
-
{
|
|
452
|
-
"name": "syn-drawer",
|
|
453
|
-
"description": "Drawers slide in from a container to expose additional options and information.\n---\n\n\n### **Events:**\n - **syn-show** - Emitted when the drawer opens.\n- **syn-after-show** - Emitted after the drawer opens and all animations are complete.\n- **syn-hide** - Emitted when the drawer closes.\n- **syn-after-hide** - Emitted after the drawer closes and all animations are complete.\n- **syn-initial-focus** - Emitted when the drawer opens and is ready to receive focus. Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.\n- **syn-request-close** - Emitted when the user attempts to close the drawer by clicking the close button, clicking the overlay, or pressing escape. Calling `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in destructive behavior such as data loss.\n\n### **Methods:**\n - **show()** - Shows the drawer.\n- **hide()** - Hides the drawer\n\n### **Slots:**\n - _default_ - The drawer's main content.\n- **label** - The drawer's label. Alternatively, you can use the `label` attribute.\n- **header-actions** - Optional actions to add to the header. Works best with `<syn-icon-button>`.\n- **footer** - The drawer's footer, usually one or more buttons representing various options.\n\n### **CSS Properties:**\n - **--size** - The preferred size of the drawer. This will be applied to the drawer's width or height depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens. _(default: undefined)_\n- **--header-spacing** - The amount of padding to use for the header. _(default: undefined)_\n- **--body-spacing** - The amount of padding to use for the body. _(default: undefined)_\n- **--footer-spacing** - The amount of padding to use for the footer. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **overlay** - The overlay that covers the screen behind the drawer.\n- **panel** - The drawer's panel (where the drawer and its content are rendered).\n- **header** - The drawer's header. This element wraps the title and header actions.\n- **header-actions** - Optional actions to add to the header. Works best with `<syn-icon-button>`.\n- **title** - The drawer's title.\n- **close-button** - The close button, an `<syn-icon-button>`.\n- **close-button__base** - The close button's exported `base` part.\n- **body** - The drawer's body.\n- **footer** - The drawer's footer.",
|
|
454
|
-
"doc-url": "",
|
|
455
|
-
"attributes": [
|
|
456
|
-
{
|
|
457
|
-
"name": "open",
|
|
458
|
-
"description": "Indicates whether or not the drawer is open. You can toggle this attribute to show and hide the drawer, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the drawer's open state.",
|
|
459
|
-
"value": { "type": "boolean", "default": "false" }
|
|
460
|
-
},
|
|
461
|
-
{
|
|
462
|
-
"name": "label",
|
|
463
|
-
"description": "The drawer's label as displayed in the header. You should always include a relevant label even when using\n`no-header`, as it is required for proper accessibility. If you need to display HTML, use the `label` slot instead.",
|
|
464
|
-
"value": { "type": "string", "default": "''" }
|
|
465
|
-
},
|
|
466
|
-
{
|
|
467
|
-
"name": "placement",
|
|
468
|
-
"description": "The direction from which the drawer will open.",
|
|
469
|
-
"value": {
|
|
470
|
-
"type": "'top' | 'end' | 'bottom' | 'start'",
|
|
471
|
-
"default": "'end'"
|
|
472
|
-
}
|
|
473
|
-
},
|
|
474
|
-
{
|
|
475
|
-
"name": "contained",
|
|
476
|
-
"description": "By default, the drawer slides out of its containing block (usually the viewport). To make the drawer slide out of\nits parent element, set this attribute and add `position: relative` to the parent.",
|
|
477
|
-
"value": { "type": "boolean", "default": "false" }
|
|
478
|
-
},
|
|
479
|
-
{
|
|
480
|
-
"name": "no-header",
|
|
481
|
-
"description": "Removes the header. This will also remove the default close button, so please ensure you provide an easy,\naccessible way for users to dismiss the drawer.",
|
|
482
|
-
"value": { "type": "boolean", "default": "false" }
|
|
483
|
-
}
|
|
484
|
-
],
|
|
485
|
-
"slots": [
|
|
486
|
-
{ "name": "", "description": "The drawer's main content." },
|
|
487
|
-
{
|
|
488
|
-
"name": "label",
|
|
489
|
-
"description": "The drawer's label. Alternatively, you can use the `label` attribute."
|
|
490
|
-
},
|
|
491
|
-
{
|
|
492
|
-
"name": "header-actions",
|
|
493
|
-
"description": "Optional actions to add to the header. Works best with `<syn-icon-button>`."
|
|
494
|
-
},
|
|
495
|
-
{
|
|
496
|
-
"name": "footer",
|
|
497
|
-
"description": "The drawer's footer, usually one or more buttons representing various options."
|
|
498
|
-
}
|
|
499
|
-
],
|
|
500
|
-
"events": [
|
|
501
|
-
{
|
|
502
|
-
"name": "syn-show",
|
|
503
|
-
"description": "Emitted when the drawer opens."
|
|
504
|
-
},
|
|
505
|
-
{
|
|
506
|
-
"name": "syn-after-show",
|
|
507
|
-
"description": "Emitted after the drawer opens and all animations are complete."
|
|
508
|
-
},
|
|
509
|
-
{
|
|
510
|
-
"name": "syn-hide",
|
|
511
|
-
"description": "Emitted when the drawer closes."
|
|
512
|
-
},
|
|
513
|
-
{
|
|
514
|
-
"name": "syn-after-hide",
|
|
515
|
-
"description": "Emitted after the drawer closes and all animations are complete."
|
|
516
|
-
},
|
|
517
|
-
{
|
|
518
|
-
"name": "syn-initial-focus",
|
|
519
|
-
"description": "Emitted when the drawer opens and is ready to receive focus. Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input."
|
|
520
|
-
},
|
|
521
|
-
{
|
|
522
|
-
"name": "syn-request-close",
|
|
523
|
-
"description": "Emitted when the user attempts to close the drawer by clicking the close button, clicking the overlay, or pressing escape. Calling `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in destructive behavior such as data loss."
|
|
524
|
-
}
|
|
525
|
-
],
|
|
526
|
-
"js": {
|
|
527
|
-
"properties": [
|
|
528
|
-
{
|
|
529
|
-
"name": "open",
|
|
530
|
-
"description": "Indicates whether or not the drawer is open. You can toggle this attribute to show and hide the drawer, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the drawer's open state.",
|
|
531
|
-
"value": { "type": "boolean" }
|
|
532
|
-
},
|
|
533
|
-
{
|
|
534
|
-
"name": "label",
|
|
535
|
-
"description": "The drawer's label as displayed in the header. You should always include a relevant label even when using\n`no-header`, as it is required for proper accessibility. If you need to display HTML, use the `label` slot instead.",
|
|
536
|
-
"value": { "type": "string" }
|
|
537
|
-
},
|
|
538
|
-
{
|
|
539
|
-
"name": "placement",
|
|
540
|
-
"description": "The direction from which the drawer will open.",
|
|
541
|
-
"value": { "type": "'top' | 'end' | 'bottom' | 'start'" }
|
|
542
|
-
},
|
|
543
|
-
{
|
|
544
|
-
"name": "contained",
|
|
545
|
-
"description": "By default, the drawer slides out of its containing block (usually the viewport). To make the drawer slide out of\nits parent element, set this attribute and add `position: relative` to the parent.",
|
|
546
|
-
"value": { "type": "boolean" }
|
|
547
|
-
},
|
|
548
|
-
{
|
|
549
|
-
"name": "no-header",
|
|
550
|
-
"description": "Removes the header. This will also remove the default close button, so please ensure you provide an easy,\naccessible way for users to dismiss the drawer.",
|
|
551
|
-
"value": { "type": "boolean" }
|
|
552
|
-
}
|
|
553
|
-
],
|
|
554
|
-
"events": [
|
|
555
|
-
{
|
|
556
|
-
"name": "syn-show",
|
|
557
|
-
"description": "Emitted when the drawer opens."
|
|
558
|
-
},
|
|
559
|
-
{
|
|
560
|
-
"name": "syn-after-show",
|
|
561
|
-
"description": "Emitted after the drawer opens and all animations are complete."
|
|
562
|
-
},
|
|
563
|
-
{
|
|
564
|
-
"name": "syn-hide",
|
|
565
|
-
"description": "Emitted when the drawer closes."
|
|
566
|
-
},
|
|
567
|
-
{
|
|
568
|
-
"name": "syn-after-hide",
|
|
569
|
-
"description": "Emitted after the drawer closes and all animations are complete."
|
|
570
|
-
},
|
|
571
|
-
{
|
|
572
|
-
"name": "syn-initial-focus",
|
|
573
|
-
"description": "Emitted when the drawer opens and is ready to receive focus. Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input."
|
|
574
|
-
},
|
|
575
|
-
{
|
|
576
|
-
"name": "syn-request-close",
|
|
577
|
-
"description": "Emitted when the user attempts to close the drawer by clicking the close button, clicking the overlay, or pressing escape. Calling `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in destructive behavior such as data loss."
|
|
578
|
-
}
|
|
579
|
-
]
|
|
580
|
-
}
|
|
581
|
-
},
|
|
582
|
-
{
|
|
583
|
-
"name": "syn-icon",
|
|
584
|
-
"description": "Icons are symbols that can be used to represent various options within an application.\n---\n\n\n### **Events:**\n - **syn-load** - Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit.\n- **syn-error** - Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit.\n\n### **CSS Parts:**\n - **svg** - The internal SVG element.\n- **use** - The <use> element generated when using `spriteSheet: true`",
|
|
585
|
-
"doc-url": "",
|
|
586
|
-
"attributes": [
|
|
587
|
-
{
|
|
588
|
-
"name": "name",
|
|
589
|
-
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
|
590
|
-
"value": { "type": "string | undefined" }
|
|
591
|
-
},
|
|
592
|
-
{
|
|
593
|
-
"name": "src",
|
|
594
|
-
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
|
595
|
-
"value": { "type": "string | undefined" }
|
|
596
|
-
},
|
|
597
|
-
{
|
|
598
|
-
"name": "label",
|
|
599
|
-
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
|
|
600
|
-
"value": { "type": "string", "default": "''" }
|
|
601
|
-
},
|
|
602
|
-
{
|
|
603
|
-
"name": "library",
|
|
604
|
-
"description": "The name of a registered custom icon library.",
|
|
605
|
-
"value": { "type": "string", "default": "'default'" }
|
|
606
|
-
}
|
|
607
|
-
],
|
|
608
|
-
"events": [
|
|
609
|
-
{
|
|
610
|
-
"name": "syn-load",
|
|
611
|
-
"description": "Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit."
|
|
612
|
-
},
|
|
613
|
-
{
|
|
614
|
-
"name": "syn-error",
|
|
615
|
-
"description": "Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit."
|
|
616
|
-
}
|
|
617
|
-
],
|
|
618
|
-
"js": {
|
|
619
|
-
"properties": [
|
|
620
|
-
{
|
|
621
|
-
"name": "name",
|
|
622
|
-
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
|
623
|
-
"value": { "type": "string | undefined" }
|
|
624
|
-
},
|
|
625
|
-
{
|
|
626
|
-
"name": "src",
|
|
627
|
-
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
|
628
|
-
"value": { "type": "string | undefined" }
|
|
629
|
-
},
|
|
630
|
-
{
|
|
631
|
-
"name": "label",
|
|
632
|
-
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
|
|
633
|
-
"value": { "type": "string" }
|
|
634
|
-
},
|
|
635
|
-
{
|
|
636
|
-
"name": "library",
|
|
637
|
-
"description": "The name of a registered custom icon library.",
|
|
638
|
-
"value": { "type": "string" }
|
|
639
|
-
}
|
|
640
|
-
],
|
|
641
|
-
"events": [
|
|
642
|
-
{
|
|
643
|
-
"name": "syn-load",
|
|
644
|
-
"description": "Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit."
|
|
645
|
-
},
|
|
646
|
-
{
|
|
647
|
-
"name": "syn-error",
|
|
648
|
-
"description": "Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit."
|
|
649
|
-
}
|
|
650
|
-
]
|
|
651
|
-
}
|
|
652
|
-
},
|
|
653
|
-
{
|
|
654
|
-
"name": "syn-icon-button",
|
|
655
|
-
"description": "Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the icon button loses focus.\n- **syn-focus** - Emitted when the icon button gains focus.\n\n### **Methods:**\n - **click()** - Simulates a click on the icon button.\n- **focus(options: _FocusOptions_)** - Sets focus on the icon button.\n- **blur()** - Removes focus from the icon button.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
656
|
-
"doc-url": "",
|
|
657
|
-
"attributes": [
|
|
658
|
-
{
|
|
659
|
-
"name": "name",
|
|
660
|
-
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
|
661
|
-
"value": { "type": "string | undefined" }
|
|
662
|
-
},
|
|
663
|
-
{
|
|
664
|
-
"name": "library",
|
|
665
|
-
"description": "The name of a registered custom icon library.",
|
|
666
|
-
"value": { "type": "string | undefined" }
|
|
667
|
-
},
|
|
668
|
-
{
|
|
669
|
-
"name": "src",
|
|
670
|
-
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
|
671
|
-
"value": { "type": "string | undefined" }
|
|
672
|
-
},
|
|
673
|
-
{
|
|
674
|
-
"name": "href",
|
|
675
|
-
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
|
676
|
-
"value": { "type": "string | undefined" }
|
|
677
|
-
},
|
|
678
|
-
{
|
|
679
|
-
"name": "target",
|
|
680
|
-
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
|
681
|
-
"value": {
|
|
682
|
-
"type": "'_blank' | '_parent' | '_self' | '_top' | undefined"
|
|
683
|
-
}
|
|
684
|
-
},
|
|
685
|
-
{
|
|
686
|
-
"name": "download",
|
|
687
|
-
"description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
|
|
688
|
-
"value": { "type": "string | undefined" }
|
|
689
|
-
},
|
|
690
|
-
{
|
|
691
|
-
"name": "label",
|
|
692
|
-
"description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
|
|
693
|
-
"value": { "type": "string", "default": "''" }
|
|
694
|
-
},
|
|
695
|
-
{
|
|
696
|
-
"name": "size",
|
|
697
|
-
"description": "The icon button's size.",
|
|
698
|
-
"value": {
|
|
699
|
-
"type": "'small' | 'medium' | 'large' | 'inherit'",
|
|
700
|
-
"default": "'inherit'"
|
|
701
|
-
}
|
|
702
|
-
},
|
|
703
|
-
{
|
|
704
|
-
"name": "color",
|
|
705
|
-
"description": "The color of the icon button.\nThe default \"currentColor\" makes it possible to easily style the icon button from outside without any CSS variables.",
|
|
706
|
-
"value": {
|
|
707
|
-
"type": "'currentColor' | 'primary' | 'neutral'",
|
|
708
|
-
"default": "'currentColor'"
|
|
709
|
-
}
|
|
710
|
-
},
|
|
711
|
-
{
|
|
712
|
-
"name": "disabled",
|
|
713
|
-
"description": "Disables the button.",
|
|
714
|
-
"value": { "type": "boolean", "default": "false" }
|
|
715
|
-
}
|
|
716
|
-
],
|
|
717
|
-
"events": [
|
|
718
|
-
{
|
|
719
|
-
"name": "syn-blur",
|
|
720
|
-
"description": "Emitted when the icon button loses focus."
|
|
721
|
-
},
|
|
722
|
-
{
|
|
723
|
-
"name": "syn-focus",
|
|
724
|
-
"description": "Emitted when the icon button gains focus."
|
|
725
|
-
}
|
|
726
|
-
],
|
|
727
|
-
"js": {
|
|
728
|
-
"properties": [
|
|
729
|
-
{
|
|
730
|
-
"name": "name",
|
|
731
|
-
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
|
732
|
-
"value": { "type": "string | undefined" }
|
|
733
|
-
},
|
|
734
|
-
{
|
|
735
|
-
"name": "library",
|
|
736
|
-
"description": "The name of a registered custom icon library.",
|
|
737
|
-
"value": { "type": "string | undefined" }
|
|
738
|
-
},
|
|
739
|
-
{
|
|
740
|
-
"name": "src",
|
|
741
|
-
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
|
742
|
-
"value": { "type": "string | undefined" }
|
|
743
|
-
},
|
|
744
|
-
{
|
|
745
|
-
"name": "href",
|
|
746
|
-
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
|
747
|
-
"value": { "type": "string | undefined" }
|
|
748
|
-
},
|
|
749
|
-
{
|
|
750
|
-
"name": "target",
|
|
751
|
-
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
|
752
|
-
"value": {
|
|
753
|
-
"type": "'_blank' | '_parent' | '_self' | '_top' | undefined"
|
|
754
|
-
}
|
|
755
|
-
},
|
|
756
|
-
{
|
|
757
|
-
"name": "download",
|
|
758
|
-
"description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
|
|
759
|
-
"value": { "type": "string | undefined" }
|
|
760
|
-
},
|
|
761
|
-
{
|
|
762
|
-
"name": "label",
|
|
763
|
-
"description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
|
|
764
|
-
"value": { "type": "string" }
|
|
765
|
-
},
|
|
766
|
-
{
|
|
767
|
-
"name": "size",
|
|
768
|
-
"description": "The icon button's size.",
|
|
769
|
-
"value": { "type": "'small' | 'medium' | 'large' | 'inherit'" }
|
|
770
|
-
},
|
|
771
|
-
{
|
|
772
|
-
"name": "color",
|
|
773
|
-
"description": "The color of the icon button.\nThe default \"currentColor\" makes it possible to easily style the icon button from outside without any CSS variables.",
|
|
774
|
-
"value": { "type": "'currentColor' | 'primary' | 'neutral'" }
|
|
775
|
-
},
|
|
776
|
-
{
|
|
777
|
-
"name": "disabled",
|
|
778
|
-
"description": "Disables the button.",
|
|
779
|
-
"value": { "type": "boolean" }
|
|
780
|
-
}
|
|
781
|
-
],
|
|
782
|
-
"events": [
|
|
783
|
-
{
|
|
784
|
-
"name": "syn-blur",
|
|
785
|
-
"description": "Emitted when the icon button loses focus."
|
|
786
|
-
},
|
|
787
|
-
{
|
|
788
|
-
"name": "syn-focus",
|
|
789
|
-
"description": "Emitted when the icon button gains focus."
|
|
790
|
-
}
|
|
791
|
-
]
|
|
792
|
-
}
|
|
793
|
-
},
|
|
794
|
-
{
|
|
795
|
-
"name": "syn-input",
|
|
796
|
-
"description": "Inputs collect data from the user.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the control loses focus.\n- **syn-change** - Emitted when an alteration to the control's value is committed by the user.\n- **syn-clear** - Emitted when the clear button is activated.\n- **syn-focus** - Emitted when the control gains focus.\n- **syn-input** - Emitted when the control receives input.\n- **syn-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the input.\n- **blur()** - Removes focus from the input.\n- **select()** - Selects all the text in the input.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\n- **showPicker()** - Displays the browser picker for an input element (only works if the browser supports it for the input type).\n- **stepUp()** - Increments the value of a numeric input type by the value of the step attribute.\n- **stepDown()** - Decrements the value of a numeric input type by the value of the step attribute.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend a presentational icon or similar element to the input.\n- **suffix** - Used to append a presentational icon or similar element to the input.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **show-password-icon** - An icon to use in lieu of the default show password icon.\n- **hide-password-icon** - An icon to use in lieu of the default hide password icon.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n- **increment-number-stepper** - An icon to use in lieu of the default increment number stepper icon.\n- **decrement-number-stepper** - An icon to use in lieu of the default decrement number stepper icon.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The input's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **input** - The internal `<input>` control.\n- **prefix** - The container that wraps the prefix.\n- **clear-button** - The clear button.\n- **password-toggle-button** - The password toggle button.\n- **suffix** - The container that wraps the suffix.\n- **stepper** - The container that wraps the number stepper.\n- **decrement-number-stepper** - The decrement number stepper button.\n- **increment-number-stepper** - The increment number stepper button.\n- **divider** - The divider between the increment and decrement number stepper buttons.",
|
|
797
|
-
"doc-url": "",
|
|
798
|
-
"attributes": [
|
|
799
|
-
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
|
800
|
-
{
|
|
801
|
-
"name": "type",
|
|
802
|
-
"description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
|
|
803
|
-
"value": {
|
|
804
|
-
"type": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'",
|
|
805
|
-
"default": "'text'"
|
|
806
|
-
}
|
|
807
|
-
},
|
|
808
|
-
{
|
|
809
|
-
"name": "name",
|
|
810
|
-
"description": "The name of the input, submitted as a name/value pair with form data.",
|
|
811
|
-
"value": { "type": "string", "default": "''" }
|
|
812
|
-
},
|
|
813
|
-
{
|
|
814
|
-
"name": "value",
|
|
815
|
-
"description": "The current value of the input, submitted as a name/value pair with form data.",
|
|
816
|
-
"value": { "type": "string", "default": "''" }
|
|
817
|
-
},
|
|
818
|
-
{
|
|
819
|
-
"name": "size",
|
|
820
|
-
"description": "The input's size.",
|
|
821
|
-
"value": {
|
|
822
|
-
"type": "'small' | 'medium' | 'large'",
|
|
823
|
-
"default": "'medium'"
|
|
824
|
-
}
|
|
825
|
-
},
|
|
826
|
-
{
|
|
827
|
-
"name": "label",
|
|
828
|
-
"description": "The input's label. If you need to display HTML, use the `label` slot instead.",
|
|
829
|
-
"value": { "type": "string", "default": "''" }
|
|
830
|
-
},
|
|
831
|
-
{
|
|
832
|
-
"name": "help-text",
|
|
833
|
-
"description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
834
|
-
"value": { "type": "string", "default": "''" }
|
|
835
|
-
},
|
|
836
|
-
{
|
|
837
|
-
"name": "clearable",
|
|
838
|
-
"description": "Adds a clear button when the input is not empty.",
|
|
839
|
-
"value": { "type": "boolean", "default": "false" }
|
|
840
|
-
},
|
|
841
|
-
{
|
|
842
|
-
"name": "disabled",
|
|
843
|
-
"description": "Disables the input.",
|
|
844
|
-
"value": { "type": "boolean", "default": "false" }
|
|
845
|
-
},
|
|
846
|
-
{
|
|
847
|
-
"name": "placeholder",
|
|
848
|
-
"description": "Placeholder text to show as a hint when the input is empty.",
|
|
849
|
-
"value": { "type": "string", "default": "''" }
|
|
850
|
-
},
|
|
851
|
-
{
|
|
852
|
-
"name": "readonly",
|
|
853
|
-
"description": "Makes the input readonly.",
|
|
854
|
-
"value": { "type": "boolean", "default": "false" }
|
|
855
|
-
},
|
|
856
|
-
{
|
|
857
|
-
"name": "password-toggle",
|
|
858
|
-
"description": "Adds a button to toggle the password's visibility. Only applies to password types.",
|
|
859
|
-
"value": { "type": "boolean", "default": "false" }
|
|
860
|
-
},
|
|
861
|
-
{
|
|
862
|
-
"name": "password-visible",
|
|
863
|
-
"description": "Determines whether or not the password is currently visible. Only applies to password input types.",
|
|
864
|
-
"value": { "type": "boolean", "default": "false" }
|
|
865
|
-
},
|
|
866
|
-
{
|
|
867
|
-
"name": "no-spin-buttons",
|
|
868
|
-
"description": "Hides the increment/decrement spin buttons for number inputs.",
|
|
869
|
-
"value": { "type": "boolean", "default": "false" }
|
|
870
|
-
},
|
|
871
|
-
{
|
|
872
|
-
"name": "form",
|
|
873
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
874
|
-
"value": { "type": "string", "default": "''" }
|
|
875
|
-
},
|
|
876
|
-
{
|
|
877
|
-
"name": "required",
|
|
878
|
-
"description": "Makes the input a required field.",
|
|
879
|
-
"value": { "type": "boolean", "default": "false" }
|
|
880
|
-
},
|
|
881
|
-
{
|
|
882
|
-
"name": "pattern",
|
|
883
|
-
"description": "A regular expression pattern to validate input against.",
|
|
884
|
-
"value": { "type": "string" }
|
|
885
|
-
},
|
|
886
|
-
{
|
|
887
|
-
"name": "minlength",
|
|
888
|
-
"description": "The minimum length of input that will be considered valid.",
|
|
889
|
-
"value": { "type": "number" }
|
|
890
|
-
},
|
|
891
|
-
{
|
|
892
|
-
"name": "maxlength",
|
|
893
|
-
"description": "The maximum length of input that will be considered valid.",
|
|
894
|
-
"value": { "type": "number" }
|
|
895
|
-
},
|
|
896
|
-
{
|
|
897
|
-
"name": "min",
|
|
898
|
-
"description": "The input's minimum value. Only applies to date and number input types.",
|
|
899
|
-
"value": { "type": "number | string" }
|
|
900
|
-
},
|
|
901
|
-
{
|
|
902
|
-
"name": "max",
|
|
903
|
-
"description": "The input's maximum value. Only applies to date and number input types.",
|
|
904
|
-
"value": { "type": "number | string" }
|
|
905
|
-
},
|
|
906
|
-
{
|
|
907
|
-
"name": "step",
|
|
908
|
-
"description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
|
|
909
|
-
"value": { "type": "number | 'any'" }
|
|
910
|
-
},
|
|
911
|
-
{
|
|
912
|
-
"name": "autocapitalize",
|
|
913
|
-
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
|
914
|
-
"value": {
|
|
915
|
-
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
|
916
|
-
}
|
|
917
|
-
},
|
|
918
|
-
{
|
|
919
|
-
"name": "autocorrect",
|
|
920
|
-
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
|
921
|
-
"value": { "type": "'off' | 'on'" }
|
|
922
|
-
},
|
|
923
|
-
{
|
|
924
|
-
"name": "autocomplete",
|
|
925
|
-
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
|
926
|
-
"value": { "type": "string" }
|
|
927
|
-
},
|
|
928
|
-
{
|
|
929
|
-
"name": "autofocus",
|
|
930
|
-
"description": "Indicates that the input should receive focus on page load.",
|
|
931
|
-
"value": { "type": "boolean" }
|
|
932
|
-
},
|
|
933
|
-
{
|
|
934
|
-
"name": "enterkeyhint",
|
|
935
|
-
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
|
936
|
-
"value": {
|
|
937
|
-
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
|
938
|
-
}
|
|
939
|
-
},
|
|
940
|
-
{
|
|
941
|
-
"name": "spellcheck",
|
|
942
|
-
"description": "Enables spell checking on the input.",
|
|
943
|
-
"value": { "type": "boolean", "default": "true" }
|
|
944
|
-
},
|
|
945
|
-
{
|
|
946
|
-
"name": "inputmode",
|
|
947
|
-
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
|
948
|
-
"value": {
|
|
949
|
-
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
|
950
|
-
}
|
|
951
|
-
}
|
|
952
|
-
],
|
|
953
|
-
"slots": [
|
|
954
|
-
{
|
|
955
|
-
"name": "label",
|
|
956
|
-
"description": "The input's label. Alternatively, you can use the `label` attribute."
|
|
957
|
-
},
|
|
958
|
-
{
|
|
959
|
-
"name": "prefix",
|
|
960
|
-
"description": "Used to prepend a presentational icon or similar element to the input."
|
|
961
|
-
},
|
|
962
|
-
{
|
|
963
|
-
"name": "suffix",
|
|
964
|
-
"description": "Used to append a presentational icon or similar element to the input."
|
|
965
|
-
},
|
|
966
|
-
{
|
|
967
|
-
"name": "clear-icon",
|
|
968
|
-
"description": "An icon to use in lieu of the default clear icon."
|
|
969
|
-
},
|
|
970
|
-
{
|
|
971
|
-
"name": "show-password-icon",
|
|
972
|
-
"description": "An icon to use in lieu of the default show password icon."
|
|
973
|
-
},
|
|
974
|
-
{
|
|
975
|
-
"name": "hide-password-icon",
|
|
976
|
-
"description": "An icon to use in lieu of the default hide password icon."
|
|
977
|
-
},
|
|
978
|
-
{
|
|
979
|
-
"name": "help-text",
|
|
980
|
-
"description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute."
|
|
981
|
-
},
|
|
982
|
-
{
|
|
983
|
-
"name": "increment-number-stepper",
|
|
984
|
-
"description": "An icon to use in lieu of the default increment number stepper icon."
|
|
985
|
-
},
|
|
986
|
-
{
|
|
987
|
-
"name": "decrement-number-stepper",
|
|
988
|
-
"description": "An icon to use in lieu of the default decrement number stepper icon."
|
|
989
|
-
}
|
|
990
|
-
],
|
|
991
|
-
"events": [
|
|
992
|
-
{
|
|
993
|
-
"name": "syn-blur",
|
|
994
|
-
"description": "Emitted when the control loses focus."
|
|
995
|
-
},
|
|
996
|
-
{
|
|
997
|
-
"name": "syn-change",
|
|
998
|
-
"description": "Emitted when an alteration to the control's value is committed by the user."
|
|
999
|
-
},
|
|
1000
|
-
{
|
|
1001
|
-
"name": "syn-clear",
|
|
1002
|
-
"description": "Emitted when the clear button is activated."
|
|
1003
|
-
},
|
|
1004
|
-
{
|
|
1005
|
-
"name": "syn-focus",
|
|
1006
|
-
"description": "Emitted when the control gains focus."
|
|
1007
|
-
},
|
|
1008
|
-
{
|
|
1009
|
-
"name": "syn-input",
|
|
1010
|
-
"description": "Emitted when the control receives input."
|
|
1011
|
-
},
|
|
1012
|
-
{
|
|
1013
|
-
"name": "syn-invalid",
|
|
1014
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
1015
|
-
}
|
|
1016
|
-
],
|
|
1017
|
-
"js": {
|
|
1018
|
-
"properties": [
|
|
1019
|
-
{ "name": "title", "value": { "type": "string" } },
|
|
1020
|
-
{
|
|
1021
|
-
"name": "type",
|
|
1022
|
-
"description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
|
|
1023
|
-
"value": {
|
|
1024
|
-
"type": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'"
|
|
1025
|
-
}
|
|
1026
|
-
},
|
|
1027
|
-
{
|
|
1028
|
-
"name": "name",
|
|
1029
|
-
"description": "The name of the input, submitted as a name/value pair with form data.",
|
|
1030
|
-
"value": { "type": "string" }
|
|
1031
|
-
},
|
|
1032
|
-
{
|
|
1033
|
-
"name": "value",
|
|
1034
|
-
"description": "The current value of the input, submitted as a name/value pair with form data.",
|
|
1035
|
-
"value": { "type": "string" }
|
|
1036
|
-
},
|
|
1037
|
-
{
|
|
1038
|
-
"name": "size",
|
|
1039
|
-
"description": "The input's size.",
|
|
1040
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
1041
|
-
},
|
|
1042
|
-
{
|
|
1043
|
-
"name": "label",
|
|
1044
|
-
"description": "The input's label. If you need to display HTML, use the `label` slot instead.",
|
|
1045
|
-
"value": { "type": "string" }
|
|
1046
|
-
},
|
|
1047
|
-
{
|
|
1048
|
-
"name": "help-text",
|
|
1049
|
-
"description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1050
|
-
"value": { "type": "string" }
|
|
1051
|
-
},
|
|
1052
|
-
{
|
|
1053
|
-
"name": "clearable",
|
|
1054
|
-
"description": "Adds a clear button when the input is not empty.",
|
|
1055
|
-
"value": { "type": "boolean" }
|
|
1056
|
-
},
|
|
1057
|
-
{
|
|
1058
|
-
"name": "disabled",
|
|
1059
|
-
"description": "Disables the input.",
|
|
1060
|
-
"value": { "type": "boolean" }
|
|
1061
|
-
},
|
|
1062
|
-
{
|
|
1063
|
-
"name": "placeholder",
|
|
1064
|
-
"description": "Placeholder text to show as a hint when the input is empty.",
|
|
1065
|
-
"value": { "type": "string" }
|
|
1066
|
-
},
|
|
1067
|
-
{
|
|
1068
|
-
"name": "readonly",
|
|
1069
|
-
"description": "Makes the input readonly.",
|
|
1070
|
-
"value": { "type": "boolean" }
|
|
1071
|
-
},
|
|
1072
|
-
{
|
|
1073
|
-
"name": "password-toggle",
|
|
1074
|
-
"description": "Adds a button to toggle the password's visibility. Only applies to password types.",
|
|
1075
|
-
"value": { "type": "boolean" }
|
|
1076
|
-
},
|
|
1077
|
-
{
|
|
1078
|
-
"name": "password-visible",
|
|
1079
|
-
"description": "Determines whether or not the password is currently visible. Only applies to password input types.",
|
|
1080
|
-
"value": { "type": "boolean" }
|
|
1081
|
-
},
|
|
1082
|
-
{
|
|
1083
|
-
"name": "no-spin-buttons",
|
|
1084
|
-
"description": "Hides the increment/decrement spin buttons for number inputs.",
|
|
1085
|
-
"value": { "type": "boolean" }
|
|
1086
|
-
},
|
|
1087
|
-
{
|
|
1088
|
-
"name": "form",
|
|
1089
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
1090
|
-
"value": { "type": "string" }
|
|
1091
|
-
},
|
|
1092
|
-
{
|
|
1093
|
-
"name": "required",
|
|
1094
|
-
"description": "Makes the input a required field.",
|
|
1095
|
-
"value": { "type": "boolean" }
|
|
1096
|
-
},
|
|
1097
|
-
{
|
|
1098
|
-
"name": "pattern",
|
|
1099
|
-
"description": "A regular expression pattern to validate input against.",
|
|
1100
|
-
"value": { "type": "string" }
|
|
1101
|
-
},
|
|
1102
|
-
{
|
|
1103
|
-
"name": "minlength",
|
|
1104
|
-
"description": "The minimum length of input that will be considered valid.",
|
|
1105
|
-
"value": { "type": "number" }
|
|
1106
|
-
},
|
|
1107
|
-
{
|
|
1108
|
-
"name": "maxlength",
|
|
1109
|
-
"description": "The maximum length of input that will be considered valid.",
|
|
1110
|
-
"value": { "type": "number" }
|
|
1111
|
-
},
|
|
1112
|
-
{
|
|
1113
|
-
"name": "min",
|
|
1114
|
-
"description": "The input's minimum value. Only applies to date and number input types.",
|
|
1115
|
-
"value": { "type": "number | string" }
|
|
1116
|
-
},
|
|
1117
|
-
{
|
|
1118
|
-
"name": "max",
|
|
1119
|
-
"description": "The input's maximum value. Only applies to date and number input types.",
|
|
1120
|
-
"value": { "type": "number | string" }
|
|
1121
|
-
},
|
|
1122
|
-
{
|
|
1123
|
-
"name": "step",
|
|
1124
|
-
"description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
|
|
1125
|
-
"value": { "type": "number | 'any'" }
|
|
1126
|
-
},
|
|
1127
|
-
{
|
|
1128
|
-
"name": "autocapitalize",
|
|
1129
|
-
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
|
1130
|
-
"value": {
|
|
1131
|
-
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
|
1132
|
-
}
|
|
1133
|
-
},
|
|
1134
|
-
{
|
|
1135
|
-
"name": "autocorrect",
|
|
1136
|
-
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
|
1137
|
-
"value": { "type": "'off' | 'on'" }
|
|
1138
|
-
},
|
|
1139
|
-
{
|
|
1140
|
-
"name": "autocomplete",
|
|
1141
|
-
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
|
1142
|
-
"value": { "type": "string" }
|
|
1143
|
-
},
|
|
1144
|
-
{
|
|
1145
|
-
"name": "autofocus",
|
|
1146
|
-
"description": "Indicates that the input should receive focus on page load.",
|
|
1147
|
-
"value": { "type": "boolean" }
|
|
1148
|
-
},
|
|
1149
|
-
{
|
|
1150
|
-
"name": "enterkeyhint",
|
|
1151
|
-
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
|
1152
|
-
"value": {
|
|
1153
|
-
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
|
1154
|
-
}
|
|
1155
|
-
},
|
|
1156
|
-
{
|
|
1157
|
-
"name": "spellcheck",
|
|
1158
|
-
"description": "Enables spell checking on the input.",
|
|
1159
|
-
"value": { "type": "boolean" }
|
|
1160
|
-
},
|
|
1161
|
-
{
|
|
1162
|
-
"name": "inputmode",
|
|
1163
|
-
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
|
1164
|
-
"value": {
|
|
1165
|
-
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
|
1166
|
-
}
|
|
1167
|
-
}
|
|
1168
|
-
],
|
|
1169
|
-
"events": [
|
|
1170
|
-
{
|
|
1171
|
-
"name": "syn-blur",
|
|
1172
|
-
"description": "Emitted when the control loses focus."
|
|
1173
|
-
},
|
|
1174
|
-
{
|
|
1175
|
-
"name": "syn-change",
|
|
1176
|
-
"description": "Emitted when an alteration to the control's value is committed by the user."
|
|
1177
|
-
},
|
|
1178
|
-
{
|
|
1179
|
-
"name": "syn-clear",
|
|
1180
|
-
"description": "Emitted when the clear button is activated."
|
|
1181
|
-
},
|
|
1182
|
-
{
|
|
1183
|
-
"name": "syn-focus",
|
|
1184
|
-
"description": "Emitted when the control gains focus."
|
|
1185
|
-
},
|
|
1186
|
-
{
|
|
1187
|
-
"name": "syn-input",
|
|
1188
|
-
"description": "Emitted when the control receives input."
|
|
1189
|
-
},
|
|
1190
|
-
{
|
|
1191
|
-
"name": "syn-invalid",
|
|
1192
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
1193
|
-
}
|
|
1194
|
-
]
|
|
1195
|
-
}
|
|
1196
|
-
},
|
|
1197
|
-
{
|
|
1198
|
-
"name": "syn-optgroup",
|
|
1199
|
-
"description": "The <syn-optgroup> element creates a grouping for <syn-option>s within a <syn-select>.\n---\n\n\n### **Slots:**\n - _default_ - The given options. Must be `<syn-option>` elements.\n- **prefix** - A presentational prefix icon or similar element.\n- **label** - The label for the optgroup\n- **suffix** - A presentational suffix icon or similar element.\n\n### **CSS Properties:**\n - **--display-divider** - Display property of the divider. Defaults to \"block\" _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label-container** - The container that wraps prefix, label and base\n- **divider** - The divider that is displayed above the content\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.\n- **options** - The container that wraps the <syn-option> elements.",
|
|
1200
|
-
"doc-url": "",
|
|
1201
|
-
"attributes": [
|
|
1202
|
-
{
|
|
1203
|
-
"name": "disabled",
|
|
1204
|
-
"description": "Disables all options in the optgroup.",
|
|
1205
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1206
|
-
},
|
|
1207
|
-
{
|
|
1208
|
-
"name": "label",
|
|
1209
|
-
"description": "The optgroups label. If you need to display HTML, use the `label` slot instead.",
|
|
1210
|
-
"value": { "type": "string", "default": "''" }
|
|
1211
|
-
}
|
|
1212
|
-
],
|
|
1213
|
-
"slots": [
|
|
1214
|
-
{
|
|
1215
|
-
"name": "",
|
|
1216
|
-
"description": "The given options. Must be `<syn-option>` elements."
|
|
1217
|
-
},
|
|
1218
|
-
{
|
|
1219
|
-
"name": "prefix",
|
|
1220
|
-
"description": "A presentational prefix icon or similar element."
|
|
1221
|
-
},
|
|
1222
|
-
{ "name": "label", "description": "The label for the optgroup" },
|
|
1223
|
-
{
|
|
1224
|
-
"name": "suffix",
|
|
1225
|
-
"description": "A presentational suffix icon or similar element."
|
|
1226
|
-
}
|
|
1227
|
-
],
|
|
1228
|
-
"events": [],
|
|
1229
|
-
"js": {
|
|
1230
|
-
"properties": [
|
|
1231
|
-
{
|
|
1232
|
-
"name": "disabled",
|
|
1233
|
-
"description": "Disables all options in the optgroup.",
|
|
1234
|
-
"value": { "type": "boolean" }
|
|
1235
|
-
},
|
|
1236
|
-
{
|
|
1237
|
-
"name": "label",
|
|
1238
|
-
"description": "The optgroups label. If you need to display HTML, use the `label` slot instead.",
|
|
1239
|
-
"value": { "type": "string" }
|
|
1240
|
-
}
|
|
1241
|
-
],
|
|
1242
|
-
"events": []
|
|
1243
|
-
}
|
|
1244
|
-
},
|
|
1245
|
-
{
|
|
1246
|
-
"name": "syn-option",
|
|
1247
|
-
"description": "Options define the selectable items within various form controls such as [select](/components/select).\n---\n\n\n### **Methods:**\n - **getTextLabel()** - Returns a plain text label based on the option's content.\n\n### **Slots:**\n - _default_ - The option's label.\n- **prefix** - Used to prepend an icon or similar element to the menu item.\n- **suffix** - Used to append an icon or similar element to the menu item.\n\n### **CSS Parts:**\n - **checked-icon** - The checked icon, an `<syn-icon>` element.\n- **base** - The component's base wrapper.\n- **label** - The option's label.\n- **prefix** - The container that wraps the prefix.\n- **suffix** - The container that wraps the suffix.",
|
|
1248
|
-
"doc-url": "",
|
|
1249
|
-
"attributes": [
|
|
1250
|
-
{
|
|
1251
|
-
"name": "value",
|
|
1252
|
-
"description": "The option's value. When selected, the containing form control will receive this value. The value must be unique\nfrom other options in the same group. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
|
|
1253
|
-
"value": { "type": "string", "default": "''" }
|
|
1254
|
-
},
|
|
1255
|
-
{
|
|
1256
|
-
"name": "disabled",
|
|
1257
|
-
"description": "Draws the option in a disabled state, preventing selection.",
|
|
1258
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1259
|
-
}
|
|
1260
|
-
],
|
|
1261
|
-
"slots": [
|
|
1262
|
-
{ "name": "", "description": "The option's label." },
|
|
1263
|
-
{
|
|
1264
|
-
"name": "prefix",
|
|
1265
|
-
"description": "Used to prepend an icon or similar element to the menu item."
|
|
1266
|
-
},
|
|
1267
|
-
{
|
|
1268
|
-
"name": "suffix",
|
|
1269
|
-
"description": "Used to append an icon or similar element to the menu item."
|
|
1270
|
-
}
|
|
1271
|
-
],
|
|
1272
|
-
"events": [],
|
|
1273
|
-
"js": {
|
|
1274
|
-
"properties": [
|
|
1275
|
-
{
|
|
1276
|
-
"name": "value",
|
|
1277
|
-
"description": "The option's value. When selected, the containing form control will receive this value. The value must be unique\nfrom other options in the same group. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
|
|
1278
|
-
"value": { "type": "string" }
|
|
1279
|
-
},
|
|
1280
|
-
{
|
|
1281
|
-
"name": "disabled",
|
|
1282
|
-
"description": "Draws the option in a disabled state, preventing selection.",
|
|
1283
|
-
"value": { "type": "boolean" }
|
|
1284
|
-
}
|
|
1285
|
-
],
|
|
1286
|
-
"events": []
|
|
1287
|
-
}
|
|
1288
|
-
},
|
|
1289
|
-
{
|
|
1290
|
-
"name": "syn-popup",
|
|
1291
|
-
"description": "Popup is a utility that lets you declaratively anchor \"popup\" containers to another element.\n---\n\n\n### **Events:**\n - **syn-reposition** - Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it.\n\n### **Methods:**\n - **reposition()** - Forces the popup to recalculate and reposition itself.\n\n### **Slots:**\n - _default_ - The popup's content.\n- **anchor** - The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead.\n\n### **CSS Properties:**\n - **--arrow-size** - The size of the arrow. Note that an arrow won't be shown unless the `arrow` attribute is used. _(default: 6px)_\n- **--arrow-color** - The color of the arrow. _(default: var(--syn-color-neutral-0))_\n- **--auto-size-available-width** - A read-only custom property that determines the amount of width the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n- **--auto-size-available-height** - A read-only custom property that determines the amount of height the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n\n### **CSS Parts:**\n - **arrow** - The arrow's container. Avoid setting `top|bottom|left|right` properties, as these values are assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and maybe a border or box shadow.\n- **popup** - The popup's container. Useful for setting a background color, box shadow, etc.",
|
|
1292
|
-
"doc-url": "",
|
|
1293
|
-
"attributes": [
|
|
1294
|
-
{
|
|
1295
|
-
"name": "anchor",
|
|
1296
|
-
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
|
|
1297
|
-
"value": { "type": "Element | string | VirtualElement" }
|
|
1298
|
-
},
|
|
1299
|
-
{
|
|
1300
|
-
"name": "active",
|
|
1301
|
-
"description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
|
|
1302
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1303
|
-
},
|
|
1304
|
-
{
|
|
1305
|
-
"name": "placement",
|
|
1306
|
-
"description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
|
|
1307
|
-
"value": {
|
|
1308
|
-
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'",
|
|
1309
|
-
"default": "'top'"
|
|
1310
|
-
}
|
|
1311
|
-
},
|
|
1312
|
-
{
|
|
1313
|
-
"name": "strategy",
|
|
1314
|
-
"description": "Determines how the popup is positioned. The `absolute` strategy works well in most cases, but if overflow is\nclipped, using a `fixed` position strategy can often workaround it.",
|
|
1315
|
-
"value": {
|
|
1316
|
-
"type": "'absolute' | 'fixed'",
|
|
1317
|
-
"default": "'absolute'"
|
|
1318
|
-
}
|
|
1319
|
-
},
|
|
1320
|
-
{
|
|
1321
|
-
"name": "distance",
|
|
1322
|
-
"description": "The distance in pixels from which to offset the panel away from its anchor.",
|
|
1323
|
-
"value": { "type": "number", "default": "0" }
|
|
1324
|
-
},
|
|
1325
|
-
{
|
|
1326
|
-
"name": "skidding",
|
|
1327
|
-
"description": "The distance in pixels from which to offset the panel along its anchor.",
|
|
1328
|
-
"value": { "type": "number", "default": "0" }
|
|
1329
|
-
},
|
|
1330
|
-
{
|
|
1331
|
-
"name": "arrow",
|
|
1332
|
-
"description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
|
|
1333
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1334
|
-
},
|
|
1335
|
-
{
|
|
1336
|
-
"name": "arrow-placement",
|
|
1337
|
-
"description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
|
|
1338
|
-
"value": {
|
|
1339
|
-
"type": "'start' | 'end' | 'center' | 'anchor'",
|
|
1340
|
-
"default": "'anchor'"
|
|
1341
|
-
}
|
|
1342
|
-
},
|
|
1343
|
-
{
|
|
1344
|
-
"name": "arrow-padding",
|
|
1345
|
-
"description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
|
|
1346
|
-
"value": { "type": "number", "default": "10" }
|
|
1347
|
-
},
|
|
1348
|
-
{
|
|
1349
|
-
"name": "flip",
|
|
1350
|
-
"description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
|
|
1351
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1352
|
-
},
|
|
1353
|
-
{
|
|
1354
|
-
"name": "flip-fallback-placements",
|
|
1355
|
-
"description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
|
|
1356
|
-
"value": { "type": "string", "default": "''" }
|
|
1357
|
-
},
|
|
1358
|
-
{
|
|
1359
|
-
"name": "flip-fallback-strategy",
|
|
1360
|
-
"description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
|
|
1361
|
-
"value": {
|
|
1362
|
-
"type": "'best-fit' | 'initial'",
|
|
1363
|
-
"default": "'best-fit'"
|
|
1364
|
-
}
|
|
1365
|
-
},
|
|
1366
|
-
{
|
|
1367
|
-
"name": "flipBoundary",
|
|
1368
|
-
"description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
1369
|
-
"value": { "type": "Element | Element[]" }
|
|
1370
|
-
},
|
|
1371
|
-
{
|
|
1372
|
-
"name": "flip-padding",
|
|
1373
|
-
"description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
|
|
1374
|
-
"value": { "type": "number", "default": "0" }
|
|
1375
|
-
},
|
|
1376
|
-
{
|
|
1377
|
-
"name": "shift",
|
|
1378
|
-
"description": "Moves the popup along the axis to keep it in view when clipped.",
|
|
1379
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1380
|
-
},
|
|
1381
|
-
{
|
|
1382
|
-
"name": "shiftBoundary",
|
|
1383
|
-
"description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
1384
|
-
"value": { "type": "Element | Element[]" }
|
|
1385
|
-
},
|
|
1386
|
-
{
|
|
1387
|
-
"name": "shift-padding",
|
|
1388
|
-
"description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
|
|
1389
|
-
"value": { "type": "number", "default": "0" }
|
|
1390
|
-
},
|
|
1391
|
-
{
|
|
1392
|
-
"name": "auto-size",
|
|
1393
|
-
"description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
|
|
1394
|
-
"value": { "type": "'horizontal' | 'vertical' | 'both'" }
|
|
1395
|
-
},
|
|
1396
|
-
{
|
|
1397
|
-
"name": "sync",
|
|
1398
|
-
"description": "Syncs the popup's width or height to that of the anchor element.",
|
|
1399
|
-
"value": { "type": "'width' | 'height' | 'both'" }
|
|
1400
|
-
},
|
|
1401
|
-
{
|
|
1402
|
-
"name": "autoSizeBoundary",
|
|
1403
|
-
"description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
1404
|
-
"value": { "type": "Element | Element[]" }
|
|
1405
|
-
},
|
|
1406
|
-
{
|
|
1407
|
-
"name": "auto-size-padding",
|
|
1408
|
-
"description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
|
|
1409
|
-
"value": { "type": "number", "default": "0" }
|
|
1410
|
-
}
|
|
1411
|
-
],
|
|
1412
|
-
"slots": [
|
|
1413
|
-
{ "name": "", "description": "The popup's content." },
|
|
1414
|
-
{
|
|
1415
|
-
"name": "anchor",
|
|
1416
|
-
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead."
|
|
1417
|
-
}
|
|
1418
|
-
],
|
|
1419
|
-
"events": [
|
|
1420
|
-
{
|
|
1421
|
-
"name": "syn-reposition",
|
|
1422
|
-
"description": "Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it."
|
|
1423
|
-
}
|
|
1424
|
-
],
|
|
1425
|
-
"js": {
|
|
1426
|
-
"properties": [
|
|
1427
|
-
{
|
|
1428
|
-
"name": "anchor",
|
|
1429
|
-
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
|
|
1430
|
-
"value": { "type": "Element | string | VirtualElement" }
|
|
1431
|
-
},
|
|
1432
|
-
{
|
|
1433
|
-
"name": "active",
|
|
1434
|
-
"description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
|
|
1435
|
-
"value": { "type": "boolean" }
|
|
1436
|
-
},
|
|
1437
|
-
{
|
|
1438
|
-
"name": "placement",
|
|
1439
|
-
"description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
|
|
1440
|
-
"value": {
|
|
1441
|
-
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
|
|
1442
|
-
}
|
|
1443
|
-
},
|
|
1444
|
-
{
|
|
1445
|
-
"name": "strategy",
|
|
1446
|
-
"description": "Determines how the popup is positioned. The `absolute` strategy works well in most cases, but if overflow is\nclipped, using a `fixed` position strategy can often workaround it.",
|
|
1447
|
-
"value": { "type": "'absolute' | 'fixed'" }
|
|
1448
|
-
},
|
|
1449
|
-
{
|
|
1450
|
-
"name": "distance",
|
|
1451
|
-
"description": "The distance in pixels from which to offset the panel away from its anchor.",
|
|
1452
|
-
"value": { "type": "number" }
|
|
1453
|
-
},
|
|
1454
|
-
{
|
|
1455
|
-
"name": "skidding",
|
|
1456
|
-
"description": "The distance in pixels from which to offset the panel along its anchor.",
|
|
1457
|
-
"value": { "type": "number" }
|
|
1458
|
-
},
|
|
1459
|
-
{
|
|
1460
|
-
"name": "arrow",
|
|
1461
|
-
"description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
|
|
1462
|
-
"value": { "type": "boolean" }
|
|
1463
|
-
},
|
|
1464
|
-
{
|
|
1465
|
-
"name": "arrow-placement",
|
|
1466
|
-
"description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
|
|
1467
|
-
"value": { "type": "'start' | 'end' | 'center' | 'anchor'" }
|
|
1468
|
-
},
|
|
1469
|
-
{
|
|
1470
|
-
"name": "arrow-padding",
|
|
1471
|
-
"description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
|
|
1472
|
-
"value": { "type": "number" }
|
|
1473
|
-
},
|
|
1474
|
-
{
|
|
1475
|
-
"name": "flip",
|
|
1476
|
-
"description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
|
|
1477
|
-
"value": { "type": "boolean" }
|
|
1478
|
-
},
|
|
1479
|
-
{
|
|
1480
|
-
"name": "flip-fallback-placements",
|
|
1481
|
-
"description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
|
|
1482
|
-
"value": { "type": "string" }
|
|
1483
|
-
},
|
|
1484
|
-
{
|
|
1485
|
-
"name": "flip-fallback-strategy",
|
|
1486
|
-
"description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
|
|
1487
|
-
"value": { "type": "'best-fit' | 'initial'" }
|
|
1488
|
-
},
|
|
1489
|
-
{
|
|
1490
|
-
"name": "flipBoundary",
|
|
1491
|
-
"description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
1492
|
-
"value": { "type": "Element | Element[]" }
|
|
1493
|
-
},
|
|
1494
|
-
{
|
|
1495
|
-
"name": "flip-padding",
|
|
1496
|
-
"description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
|
|
1497
|
-
"value": { "type": "number" }
|
|
1498
|
-
},
|
|
1499
|
-
{
|
|
1500
|
-
"name": "shift",
|
|
1501
|
-
"description": "Moves the popup along the axis to keep it in view when clipped.",
|
|
1502
|
-
"value": { "type": "boolean" }
|
|
1503
|
-
},
|
|
1504
|
-
{
|
|
1505
|
-
"name": "shiftBoundary",
|
|
1506
|
-
"description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
1507
|
-
"value": { "type": "Element | Element[]" }
|
|
1508
|
-
},
|
|
1509
|
-
{
|
|
1510
|
-
"name": "shift-padding",
|
|
1511
|
-
"description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
|
|
1512
|
-
"value": { "type": "number" }
|
|
1513
|
-
},
|
|
1514
|
-
{
|
|
1515
|
-
"name": "auto-size",
|
|
1516
|
-
"description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
|
|
1517
|
-
"value": { "type": "'horizontal' | 'vertical' | 'both'" }
|
|
1518
|
-
},
|
|
1519
|
-
{
|
|
1520
|
-
"name": "sync",
|
|
1521
|
-
"description": "Syncs the popup's width or height to that of the anchor element.",
|
|
1522
|
-
"value": { "type": "'width' | 'height' | 'both'" }
|
|
1523
|
-
},
|
|
1524
|
-
{
|
|
1525
|
-
"name": "autoSizeBoundary",
|
|
1526
|
-
"description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
|
1527
|
-
"value": { "type": "Element | Element[]" }
|
|
1528
|
-
},
|
|
1529
|
-
{
|
|
1530
|
-
"name": "auto-size-padding",
|
|
1531
|
-
"description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
|
|
1532
|
-
"value": { "type": "number" }
|
|
1533
|
-
}
|
|
1534
|
-
],
|
|
1535
|
-
"events": [
|
|
1536
|
-
{
|
|
1537
|
-
"name": "syn-reposition",
|
|
1538
|
-
"description": "Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it."
|
|
1539
|
-
}
|
|
1540
|
-
]
|
|
1541
|
-
}
|
|
1542
|
-
},
|
|
1543
|
-
{
|
|
1544
|
-
"name": "syn-radio",
|
|
1545
|
-
"description": "Radios allow the user to select a single option from a group.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the control loses focus.\n- **syn-focus** - Emitted when the control gains focus.\n\n### **Slots:**\n - _default_ - The radio's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The circular container that wraps the radio's checked state.\n- **control--checked** - The radio control when the radio is checked.\n- **checked-icon** - The checked icon, an `<syn-icon>` element.\n- **label** - The container that wraps the radio's label.",
|
|
1546
|
-
"doc-url": "",
|
|
1547
|
-
"attributes": [
|
|
1548
|
-
{
|
|
1549
|
-
"name": "value",
|
|
1550
|
-
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1551
|
-
"value": { "type": "string" }
|
|
1552
|
-
},
|
|
1553
|
-
{
|
|
1554
|
-
"name": "size",
|
|
1555
|
-
"description": "The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this\nattribute can typically be omitted.",
|
|
1556
|
-
"value": {
|
|
1557
|
-
"type": "'small' | 'medium' | 'large'",
|
|
1558
|
-
"default": "'medium'"
|
|
1559
|
-
}
|
|
1560
|
-
},
|
|
1561
|
-
{
|
|
1562
|
-
"name": "disabled",
|
|
1563
|
-
"description": "Disables the radio.",
|
|
1564
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1565
|
-
}
|
|
1566
|
-
],
|
|
1567
|
-
"slots": [{ "name": "", "description": "The radio's label." }],
|
|
1568
|
-
"events": [
|
|
1569
|
-
{
|
|
1570
|
-
"name": "syn-blur",
|
|
1571
|
-
"description": "Emitted when the control loses focus."
|
|
1572
|
-
},
|
|
1573
|
-
{
|
|
1574
|
-
"name": "syn-focus",
|
|
1575
|
-
"description": "Emitted when the control gains focus."
|
|
1576
|
-
}
|
|
1577
|
-
],
|
|
1578
|
-
"js": {
|
|
1579
|
-
"properties": [
|
|
1580
|
-
{
|
|
1581
|
-
"name": "value",
|
|
1582
|
-
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1583
|
-
"value": { "type": "string" }
|
|
1584
|
-
},
|
|
1585
|
-
{
|
|
1586
|
-
"name": "size",
|
|
1587
|
-
"description": "The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this\nattribute can typically be omitted.",
|
|
1588
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
1589
|
-
},
|
|
1590
|
-
{
|
|
1591
|
-
"name": "disabled",
|
|
1592
|
-
"description": "Disables the radio.",
|
|
1593
|
-
"value": { "type": "boolean" }
|
|
1594
|
-
}
|
|
1595
|
-
],
|
|
1596
|
-
"events": [
|
|
1597
|
-
{
|
|
1598
|
-
"name": "syn-blur",
|
|
1599
|
-
"description": "Emitted when the control loses focus."
|
|
1600
|
-
},
|
|
1601
|
-
{
|
|
1602
|
-
"name": "syn-focus",
|
|
1603
|
-
"description": "Emitted when the control gains focus."
|
|
1604
|
-
}
|
|
1605
|
-
]
|
|
1606
|
-
}
|
|
1607
|
-
},
|
|
1608
|
-
{
|
|
1609
|
-
"name": "syn-radio-button",
|
|
1610
|
-
"description": "Radios buttons allow the user to select a single option from a group using a button-like control.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the button loses focus.\n- **syn-focus** - Emitted when the button gains focus.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the radio button.\n- **blur()** - Removes focus from the radio button.\n\n### **Slots:**\n - _default_ - The radio button's label.\n- **prefix** - A presentational prefix icon or similar element.\n- **suffix** - A presentational suffix icon or similar element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **button** - The internal `<button>` element.\n- **button--checked** - The internal button element when the radio button is checked.\n- **prefix** - The container that wraps the prefix.\n- **label** - The container that wraps the radio button's label.\n- **suffix** - The container that wraps the suffix.",
|
|
1611
|
-
"doc-url": "",
|
|
1612
|
-
"attributes": [
|
|
1613
|
-
{
|
|
1614
|
-
"name": "value",
|
|
1615
|
-
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1616
|
-
"value": { "type": "string" }
|
|
1617
|
-
},
|
|
1618
|
-
{
|
|
1619
|
-
"name": "disabled",
|
|
1620
|
-
"description": "Disables the radio button.",
|
|
1621
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1622
|
-
},
|
|
1623
|
-
{
|
|
1624
|
-
"name": "size",
|
|
1625
|
-
"description": "The radio button's size. When used inside a radio group, the size will be determined by the radio group's size so\nthis attribute can typically be omitted.",
|
|
1626
|
-
"value": {
|
|
1627
|
-
"type": "'small' | 'medium' | 'large'",
|
|
1628
|
-
"default": "'medium'"
|
|
1629
|
-
}
|
|
1630
|
-
}
|
|
1631
|
-
],
|
|
1632
|
-
"slots": [
|
|
1633
|
-
{ "name": "", "description": "The radio button's label." },
|
|
1634
|
-
{
|
|
1635
|
-
"name": "prefix",
|
|
1636
|
-
"description": "A presentational prefix icon or similar element."
|
|
1637
|
-
},
|
|
1638
|
-
{
|
|
1639
|
-
"name": "suffix",
|
|
1640
|
-
"description": "A presentational suffix icon or similar element."
|
|
1641
|
-
}
|
|
1642
|
-
],
|
|
1643
|
-
"events": [
|
|
1644
|
-
{
|
|
1645
|
-
"name": "syn-blur",
|
|
1646
|
-
"description": "Emitted when the button loses focus."
|
|
1647
|
-
},
|
|
1648
|
-
{
|
|
1649
|
-
"name": "syn-focus",
|
|
1650
|
-
"description": "Emitted when the button gains focus."
|
|
1651
|
-
}
|
|
1652
|
-
],
|
|
1653
|
-
"js": {
|
|
1654
|
-
"properties": [
|
|
1655
|
-
{
|
|
1656
|
-
"name": "value",
|
|
1657
|
-
"description": "The radio's value. When selected, the radio group will receive this value.",
|
|
1658
|
-
"value": { "type": "string" }
|
|
1659
|
-
},
|
|
1660
|
-
{
|
|
1661
|
-
"name": "disabled",
|
|
1662
|
-
"description": "Disables the radio button.",
|
|
1663
|
-
"value": { "type": "boolean" }
|
|
1664
|
-
},
|
|
1665
|
-
{
|
|
1666
|
-
"name": "size",
|
|
1667
|
-
"description": "The radio button's size. When used inside a radio group, the size will be determined by the radio group's size so\nthis attribute can typically be omitted.",
|
|
1668
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
1669
|
-
}
|
|
1670
|
-
],
|
|
1671
|
-
"events": [
|
|
1672
|
-
{
|
|
1673
|
-
"name": "syn-blur",
|
|
1674
|
-
"description": "Emitted when the button loses focus."
|
|
1675
|
-
},
|
|
1676
|
-
{
|
|
1677
|
-
"name": "syn-focus",
|
|
1678
|
-
"description": "Emitted when the button gains focus."
|
|
1679
|
-
}
|
|
1680
|
-
]
|
|
1681
|
-
}
|
|
1682
|
-
},
|
|
1683
|
-
{
|
|
1684
|
-
"name": "syn-radio-group",
|
|
1685
|
-
"description": "Radio groups are used to group multiple [radios](/components/radio) or [radio buttons](/components/radio-button) so they function as a single form control.\n---\n\n\n### **Events:**\n - **syn-change** - Emitted when the radio group's selected value changes.\n- **syn-input** - Emitted when the radio group receives user input.\n- **syn-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity(): _boolean_** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The default slot where `<syn-radio>` or `<syn-radio-button>` elements are placed.\n- **label** - The radio group's label. Required for proper accessibility. Alternatively, you can use the `label` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The input's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **button-group** - The button group that wraps radio buttons.\n- **button-group__base** - The button group's `base` part.",
|
|
1686
|
-
"doc-url": "",
|
|
1687
|
-
"attributes": [
|
|
1688
|
-
{
|
|
1689
|
-
"name": "label",
|
|
1690
|
-
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
1691
|
-
"value": { "type": "string", "default": "''" }
|
|
1692
|
-
},
|
|
1693
|
-
{
|
|
1694
|
-
"name": "help-text",
|
|
1695
|
-
"description": "The radio groups's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1696
|
-
"value": { "type": "string", "default": "''" }
|
|
1697
|
-
},
|
|
1698
|
-
{
|
|
1699
|
-
"name": "name",
|
|
1700
|
-
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
1701
|
-
"value": { "type": "string", "default": "'option'" }
|
|
1702
|
-
},
|
|
1703
|
-
{
|
|
1704
|
-
"name": "value",
|
|
1705
|
-
"description": "The current value of the radio group, submitted as a name/value pair with form data.",
|
|
1706
|
-
"value": { "type": "string", "default": "''" }
|
|
1707
|
-
},
|
|
1708
|
-
{
|
|
1709
|
-
"name": "size",
|
|
1710
|
-
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
1711
|
-
"value": {
|
|
1712
|
-
"type": "'small' | 'medium' | 'large'",
|
|
1713
|
-
"default": "'medium'"
|
|
1714
|
-
}
|
|
1715
|
-
},
|
|
1716
|
-
{
|
|
1717
|
-
"name": "form",
|
|
1718
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
1719
|
-
"value": { "type": "string", "default": "''" }
|
|
1720
|
-
},
|
|
1721
|
-
{
|
|
1722
|
-
"name": "required",
|
|
1723
|
-
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
|
1724
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1725
|
-
}
|
|
1726
|
-
],
|
|
1727
|
-
"slots": [
|
|
1728
|
-
{
|
|
1729
|
-
"name": "",
|
|
1730
|
-
"description": "The default slot where `<syn-radio>` or `<syn-radio-button>` elements are placed."
|
|
1731
|
-
},
|
|
1732
|
-
{
|
|
1733
|
-
"name": "label",
|
|
1734
|
-
"description": "The radio group's label. Required for proper accessibility. Alternatively, you can use the `label` attribute."
|
|
1735
|
-
}
|
|
1736
|
-
],
|
|
1737
|
-
"events": [
|
|
1738
|
-
{
|
|
1739
|
-
"name": "syn-change",
|
|
1740
|
-
"description": "Emitted when the radio group's selected value changes."
|
|
1741
|
-
},
|
|
1742
|
-
{
|
|
1743
|
-
"name": "syn-input",
|
|
1744
|
-
"description": "Emitted when the radio group receives user input."
|
|
1745
|
-
},
|
|
1746
|
-
{
|
|
1747
|
-
"name": "syn-invalid",
|
|
1748
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
1749
|
-
}
|
|
1750
|
-
],
|
|
1751
|
-
"js": {
|
|
1752
|
-
"properties": [
|
|
1753
|
-
{
|
|
1754
|
-
"name": "label",
|
|
1755
|
-
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
|
1756
|
-
"value": { "type": "string" }
|
|
1757
|
-
},
|
|
1758
|
-
{
|
|
1759
|
-
"name": "help-text",
|
|
1760
|
-
"description": "The radio groups's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1761
|
-
"value": { "type": "string" }
|
|
1762
|
-
},
|
|
1763
|
-
{
|
|
1764
|
-
"name": "name",
|
|
1765
|
-
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
|
1766
|
-
"value": { "type": "string" }
|
|
1767
|
-
},
|
|
1768
|
-
{
|
|
1769
|
-
"name": "value",
|
|
1770
|
-
"description": "The current value of the radio group, submitted as a name/value pair with form data.",
|
|
1771
|
-
"value": { "type": "string" }
|
|
1772
|
-
},
|
|
1773
|
-
{
|
|
1774
|
-
"name": "size",
|
|
1775
|
-
"description": "The radio group's size. This size will be applied to all child radios and radio buttons.",
|
|
1776
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
1777
|
-
},
|
|
1778
|
-
{
|
|
1779
|
-
"name": "form",
|
|
1780
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
1781
|
-
"value": { "type": "string" }
|
|
1782
|
-
},
|
|
1783
|
-
{
|
|
1784
|
-
"name": "required",
|
|
1785
|
-
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
|
1786
|
-
"value": { "type": "boolean" }
|
|
1787
|
-
}
|
|
1788
|
-
],
|
|
1789
|
-
"events": [
|
|
1790
|
-
{
|
|
1791
|
-
"name": "syn-change",
|
|
1792
|
-
"description": "Emitted when the radio group's selected value changes."
|
|
1793
|
-
},
|
|
1794
|
-
{
|
|
1795
|
-
"name": "syn-input",
|
|
1796
|
-
"description": "Emitted when the radio group receives user input."
|
|
1797
|
-
},
|
|
1798
|
-
{
|
|
1799
|
-
"name": "syn-invalid",
|
|
1800
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
1801
|
-
}
|
|
1802
|
-
]
|
|
1803
|
-
}
|
|
1804
|
-
},
|
|
1805
|
-
{
|
|
1806
|
-
"name": "syn-select",
|
|
1807
|
-
"description": "Selects allow you to choose items from a menu of predefined options.\n---\n\n\n### **Events:**\n - **syn-change** - Emitted when the control's value changes.\n- **syn-clear** - Emitted when the control's value is cleared.\n- **syn-input** - Emitted when the control receives input.\n- **syn-focus** - Emitted when the control gains focus.\n- **syn-blur** - Emitted when the control loses focus.\n- **syn-show** - Emitted when the select's menu opens.\n- **syn-after-show** - Emitted after the select's menu opens and all animations are complete.\n- **syn-hide** - Emitted when the select's menu closes.\n- **syn-after-hide** - Emitted after the select's menu closes and all animations are complete.\n- **syn-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **show()** - Shows the listbox.\n- **hide()** - Hides the listbox.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - _default_ - The listbox options. Must be `<syn-option>` elements. You can use `<syn-divider>` to group items visually.\n- **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **prefix** - Used to prepend a presentational icon or similar element to the combobox.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The select's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container the wraps the prefix, combobox, clear icon, and expand button.\n- **prefix** - The container that wraps the prefix slot.\n- **display-input** - The element that displays the selected option's label, an `<input>` element.\n- **listbox** - The listbox container where options are slotted.\n- **tags** - The container that houses option tags when `multiselect` is used.\n- **tag** - The individual tags that represent each multiselect option.\n- **tag__base** - The tag's base part.\n- **tag__content** - The tag's content part.\n- **tag__remove-button** - The tag's remove button.\n- **tag__remove-button__base** - The tag's remove button base part.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
|
|
1808
|
-
"doc-url": "",
|
|
1809
|
-
"attributes": [
|
|
1810
|
-
{
|
|
1811
|
-
"name": "name",
|
|
1812
|
-
"description": "The name of the select, submitted as a name/value pair with form data.",
|
|
1813
|
-
"value": { "type": "string", "default": "''" }
|
|
1814
|
-
},
|
|
1815
|
-
{
|
|
1816
|
-
"name": "value",
|
|
1817
|
-
"description": "The current value of the select, submitted as a name/value pair with form data. When `multiple` is enabled, the\nvalue attribute will be a space-delimited list of values based on the options selected, and the value property will\nbe an array. **For this reason, values must not contain spaces.**",
|
|
1818
|
-
"value": { "type": "string | string[]", "default": "''" }
|
|
1819
|
-
},
|
|
1820
|
-
{
|
|
1821
|
-
"name": "size",
|
|
1822
|
-
"description": "The select's size.",
|
|
1823
|
-
"value": {
|
|
1824
|
-
"type": "'small' | 'medium' | 'large'",
|
|
1825
|
-
"default": "'medium'"
|
|
1826
|
-
}
|
|
1827
|
-
},
|
|
1828
|
-
{
|
|
1829
|
-
"name": "placeholder",
|
|
1830
|
-
"description": "Placeholder text to show as a hint when the select is empty.",
|
|
1831
|
-
"value": { "type": "string", "default": "''" }
|
|
1832
|
-
},
|
|
1833
|
-
{
|
|
1834
|
-
"name": "multiple",
|
|
1835
|
-
"description": "Allows more than one option to be selected.",
|
|
1836
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1837
|
-
},
|
|
1838
|
-
{
|
|
1839
|
-
"name": "max-options-visible",
|
|
1840
|
-
"description": "The maximum number of selected options to show when `multiple` is true. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
|
1841
|
-
"value": { "type": "number", "default": "3" }
|
|
1842
|
-
},
|
|
1843
|
-
{
|
|
1844
|
-
"name": "disabled",
|
|
1845
|
-
"description": "Disables the select control.",
|
|
1846
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1847
|
-
},
|
|
1848
|
-
{
|
|
1849
|
-
"name": "clearable",
|
|
1850
|
-
"description": "Adds a clear button when the select is not empty.",
|
|
1851
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1852
|
-
},
|
|
1853
|
-
{
|
|
1854
|
-
"name": "open",
|
|
1855
|
-
"description": "Indicates whether or not the select is open. You can toggle this attribute to show and hide the menu, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the select's open state.",
|
|
1856
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1857
|
-
},
|
|
1858
|
-
{
|
|
1859
|
-
"name": "hoist",
|
|
1860
|
-
"description": "Enable this option to prevent the listbox from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.",
|
|
1861
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1862
|
-
},
|
|
1863
|
-
{
|
|
1864
|
-
"name": "label",
|
|
1865
|
-
"description": "The select's label. If you need to display HTML, use the `label` slot instead.",
|
|
1866
|
-
"value": { "type": "string", "default": "''" }
|
|
1867
|
-
},
|
|
1868
|
-
{
|
|
1869
|
-
"name": "placement",
|
|
1870
|
-
"description": "The preferred placement of the select's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.",
|
|
1871
|
-
"value": { "type": "'top' | 'bottom'", "default": "'bottom'" }
|
|
1872
|
-
},
|
|
1873
|
-
{
|
|
1874
|
-
"name": "help-text",
|
|
1875
|
-
"description": "The select's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
1876
|
-
"value": { "type": "string", "default": "''" }
|
|
1877
|
-
},
|
|
1878
|
-
{
|
|
1879
|
-
"name": "form",
|
|
1880
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
1881
|
-
"value": { "type": "string", "default": "''" }
|
|
1882
|
-
},
|
|
1883
|
-
{
|
|
1884
|
-
"name": "required",
|
|
1885
|
-
"description": "The select's required attribute.",
|
|
1886
|
-
"value": { "type": "boolean", "default": "false" }
|
|
1887
|
-
},
|
|
1888
|
-
{
|
|
1889
|
-
"name": "getTag",
|
|
1890
|
-
"description": "A function that customizes the tags to be rendered when multiple=true. The first argument is the option, the second\nis the current tag's index. The function should return either a Lit TemplateResult or a string containing trusted HTML of the symbol to render at\nthe specified value.",
|
|
1891
|
-
"value": {
|
|
1892
|
-
"type": "(option: SynOption, index: number) => TemplateResult | string | HTMLElement"
|
|
1893
|
-
}
|
|
1894
|
-
}
|
|
1895
|
-
],
|
|
1896
|
-
"slots": [
|
|
1897
|
-
{
|
|
1898
|
-
"name": "",
|
|
1899
|
-
"description": "The listbox options. Must be `<syn-option>` elements. You can use `<syn-divider>` to group items visually."
|
|
1900
|
-
},
|
|
1901
|
-
{
|
|
1902
|
-
"name": "label",
|
|
1903
|
-
"description": "The input's label. Alternatively, you can use the `label` attribute."
|
|
1904
|
-
},
|
|
1905
|
-
{
|
|
1906
|
-
"name": "prefix",
|
|
1907
|
-
"description": "Used to prepend a presentational icon or similar element to the combobox."
|
|
1908
|
-
},
|
|
1909
|
-
{
|
|
1910
|
-
"name": "clear-icon",
|
|
1911
|
-
"description": "An icon to use in lieu of the default clear icon."
|
|
1912
|
-
},
|
|
1913
|
-
{
|
|
1914
|
-
"name": "expand-icon",
|
|
1915
|
-
"description": "The icon to show when the control is expanded and collapsed. Rotates on open and close."
|
|
1916
|
-
},
|
|
1917
|
-
{
|
|
1918
|
-
"name": "help-text",
|
|
1919
|
-
"description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute."
|
|
1920
|
-
}
|
|
1921
|
-
],
|
|
1922
|
-
"events": [
|
|
1923
|
-
{
|
|
1924
|
-
"name": "syn-change",
|
|
1925
|
-
"description": "Emitted when the control's value changes."
|
|
1926
|
-
},
|
|
1927
|
-
{
|
|
1928
|
-
"name": "syn-clear",
|
|
1929
|
-
"description": "Emitted when the control's value is cleared."
|
|
1930
|
-
},
|
|
1931
|
-
{
|
|
1932
|
-
"name": "syn-input",
|
|
1933
|
-
"description": "Emitted when the control receives input."
|
|
1934
|
-
},
|
|
1935
|
-
{
|
|
1936
|
-
"name": "syn-focus",
|
|
1937
|
-
"description": "Emitted when the control gains focus."
|
|
1938
|
-
},
|
|
1939
|
-
{
|
|
1940
|
-
"name": "syn-blur",
|
|
1941
|
-
"description": "Emitted when the control loses focus."
|
|
1942
|
-
},
|
|
1943
|
-
{
|
|
1944
|
-
"name": "syn-show",
|
|
1945
|
-
"description": "Emitted when the select's menu opens."
|
|
1946
|
-
},
|
|
1947
|
-
{
|
|
1948
|
-
"name": "syn-after-show",
|
|
1949
|
-
"description": "Emitted after the select's menu opens and all animations are complete."
|
|
1950
|
-
},
|
|
1951
|
-
{
|
|
1952
|
-
"name": "syn-hide",
|
|
1953
|
-
"description": "Emitted when the select's menu closes."
|
|
1954
|
-
},
|
|
1955
|
-
{
|
|
1956
|
-
"name": "syn-after-hide",
|
|
1957
|
-
"description": "Emitted after the select's menu closes and all animations are complete."
|
|
1958
|
-
},
|
|
1959
|
-
{
|
|
1960
|
-
"name": "syn-invalid",
|
|
1961
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
1962
|
-
}
|
|
1963
|
-
],
|
|
1964
|
-
"js": {
|
|
1965
|
-
"properties": [
|
|
1966
|
-
{
|
|
1967
|
-
"name": "name",
|
|
1968
|
-
"description": "The name of the select, submitted as a name/value pair with form data.",
|
|
1969
|
-
"value": { "type": "string" }
|
|
1970
|
-
},
|
|
1971
|
-
{
|
|
1972
|
-
"name": "value",
|
|
1973
|
-
"description": "The current value of the select, submitted as a name/value pair with form data. When `multiple` is enabled, the\nvalue attribute will be a space-delimited list of values based on the options selected, and the value property will\nbe an array. **For this reason, values must not contain spaces.**",
|
|
1974
|
-
"value": { "type": "string | string[]" }
|
|
1975
|
-
},
|
|
1976
|
-
{
|
|
1977
|
-
"name": "size",
|
|
1978
|
-
"description": "The select's size.",
|
|
1979
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
1980
|
-
},
|
|
1981
|
-
{
|
|
1982
|
-
"name": "placeholder",
|
|
1983
|
-
"description": "Placeholder text to show as a hint when the select is empty.",
|
|
1984
|
-
"value": { "type": "string" }
|
|
1985
|
-
},
|
|
1986
|
-
{
|
|
1987
|
-
"name": "multiple",
|
|
1988
|
-
"description": "Allows more than one option to be selected.",
|
|
1989
|
-
"value": { "type": "boolean" }
|
|
1990
|
-
},
|
|
1991
|
-
{
|
|
1992
|
-
"name": "max-options-visible",
|
|
1993
|
-
"description": "The maximum number of selected options to show when `multiple` is true. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
|
1994
|
-
"value": { "type": "number" }
|
|
1995
|
-
},
|
|
1996
|
-
{
|
|
1997
|
-
"name": "disabled",
|
|
1998
|
-
"description": "Disables the select control.",
|
|
1999
|
-
"value": { "type": "boolean" }
|
|
2000
|
-
},
|
|
2001
|
-
{
|
|
2002
|
-
"name": "clearable",
|
|
2003
|
-
"description": "Adds a clear button when the select is not empty.",
|
|
2004
|
-
"value": { "type": "boolean" }
|
|
2005
|
-
},
|
|
2006
|
-
{
|
|
2007
|
-
"name": "open",
|
|
2008
|
-
"description": "Indicates whether or not the select is open. You can toggle this attribute to show and hide the menu, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the select's open state.",
|
|
2009
|
-
"value": { "type": "boolean" }
|
|
2010
|
-
},
|
|
2011
|
-
{
|
|
2012
|
-
"name": "hoist",
|
|
2013
|
-
"description": "Enable this option to prevent the listbox from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.",
|
|
2014
|
-
"value": { "type": "boolean" }
|
|
2015
|
-
},
|
|
2016
|
-
{
|
|
2017
|
-
"name": "label",
|
|
2018
|
-
"description": "The select's label. If you need to display HTML, use the `label` slot instead.",
|
|
2019
|
-
"value": { "type": "string" }
|
|
2020
|
-
},
|
|
2021
|
-
{
|
|
2022
|
-
"name": "placement",
|
|
2023
|
-
"description": "The preferred placement of the select's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.",
|
|
2024
|
-
"value": { "type": "'top' | 'bottom'" }
|
|
2025
|
-
},
|
|
2026
|
-
{
|
|
2027
|
-
"name": "help-text",
|
|
2028
|
-
"description": "The select's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
2029
|
-
"value": { "type": "string" }
|
|
2030
|
-
},
|
|
2031
|
-
{
|
|
2032
|
-
"name": "form",
|
|
2033
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
2034
|
-
"value": { "type": "string" }
|
|
2035
|
-
},
|
|
2036
|
-
{
|
|
2037
|
-
"name": "required",
|
|
2038
|
-
"description": "The select's required attribute.",
|
|
2039
|
-
"value": { "type": "boolean" }
|
|
2040
|
-
},
|
|
2041
|
-
{
|
|
2042
|
-
"name": "getTag",
|
|
2043
|
-
"description": "A function that customizes the tags to be rendered when multiple=true. The first argument is the option, the second\nis the current tag's index. The function should return either a Lit TemplateResult or a string containing trusted HTML of the symbol to render at\nthe specified value.",
|
|
2044
|
-
"value": {
|
|
2045
|
-
"type": "(option: SynOption, index: number) => TemplateResult | string | HTMLElement"
|
|
2046
|
-
}
|
|
2047
|
-
}
|
|
2048
|
-
],
|
|
2049
|
-
"events": [
|
|
2050
|
-
{
|
|
2051
|
-
"name": "syn-change",
|
|
2052
|
-
"description": "Emitted when the control's value changes."
|
|
2053
|
-
},
|
|
2054
|
-
{
|
|
2055
|
-
"name": "syn-clear",
|
|
2056
|
-
"description": "Emitted when the control's value is cleared."
|
|
2057
|
-
},
|
|
2058
|
-
{
|
|
2059
|
-
"name": "syn-input",
|
|
2060
|
-
"description": "Emitted when the control receives input."
|
|
2061
|
-
},
|
|
2062
|
-
{
|
|
2063
|
-
"name": "syn-focus",
|
|
2064
|
-
"description": "Emitted when the control gains focus."
|
|
2065
|
-
},
|
|
2066
|
-
{
|
|
2067
|
-
"name": "syn-blur",
|
|
2068
|
-
"description": "Emitted when the control loses focus."
|
|
2069
|
-
},
|
|
2070
|
-
{
|
|
2071
|
-
"name": "syn-show",
|
|
2072
|
-
"description": "Emitted when the select's menu opens."
|
|
2073
|
-
},
|
|
2074
|
-
{
|
|
2075
|
-
"name": "syn-after-show",
|
|
2076
|
-
"description": "Emitted after the select's menu opens and all animations are complete."
|
|
2077
|
-
},
|
|
2078
|
-
{
|
|
2079
|
-
"name": "syn-hide",
|
|
2080
|
-
"description": "Emitted when the select's menu closes."
|
|
2081
|
-
},
|
|
2082
|
-
{
|
|
2083
|
-
"name": "syn-after-hide",
|
|
2084
|
-
"description": "Emitted after the select's menu closes and all animations are complete."
|
|
2085
|
-
},
|
|
2086
|
-
{
|
|
2087
|
-
"name": "syn-invalid",
|
|
2088
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
2089
|
-
}
|
|
2090
|
-
]
|
|
2091
|
-
}
|
|
2092
|
-
},
|
|
2093
|
-
{
|
|
2094
|
-
"name": "syn-spinner",
|
|
2095
|
-
"description": "Spinners are used to show the progress of an indeterminate operation.\n---\n\n\n### **CSS Properties:**\n - **--track-width** - The width of the track. _(default: undefined)_\n- **--track-color** - The color of the track. _(default: undefined)_\n- **--indicator-color** - The color of the spinner's indicator. _(default: undefined)_\n- **--speed** - The time it takes for the spinner to complete one animation cycle. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
2096
|
-
"doc-url": "",
|
|
2097
|
-
"attributes": [],
|
|
2098
|
-
"events": [],
|
|
2099
|
-
"js": {
|
|
2100
|
-
"properties": [{ "name": "localize", "value": {} }],
|
|
2101
|
-
"events": []
|
|
2102
|
-
}
|
|
2103
|
-
},
|
|
2104
|
-
{
|
|
2105
|
-
"name": "syn-switch",
|
|
2106
|
-
"description": "Switches allow the user to toggle an option on or off.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the control loses focus.\n- **syn-change** - Emitted when the control's checked state changes.\n- **syn-input** - Emitted when the control receives input.\n- **syn-focus** - Emitted when the control gains focus.\n- **syn-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the switch.\n- **focus(options: _FocusOptions_)** - Sets focus on the switch.\n- **blur()** - Removes focus from the switch.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The switch's label.\n\n### **CSS Properties:**\n - **--width** - The width of the switch. _(default: undefined)_\n- **--height** - The height of the switch. _(default: undefined)_\n- **--thumb-size** - The size of the thumb. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The control that houses the switch's thumb.\n- **thumb** - The switch's thumb.\n- **label** - The switch's label.",
|
|
2107
|
-
"doc-url": "",
|
|
2108
|
-
"attributes": [
|
|
2109
|
-
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
|
2110
|
-
{
|
|
2111
|
-
"name": "name",
|
|
2112
|
-
"description": "The name of the switch, submitted as a name/value pair with form data.",
|
|
2113
|
-
"value": { "type": "string", "default": "''" }
|
|
2114
|
-
},
|
|
2115
|
-
{
|
|
2116
|
-
"name": "value",
|
|
2117
|
-
"description": "The current value of the switch, submitted as a name/value pair with form data.",
|
|
2118
|
-
"value": { "type": "string" }
|
|
2119
|
-
},
|
|
2120
|
-
{
|
|
2121
|
-
"name": "size",
|
|
2122
|
-
"description": "The switch's size.",
|
|
2123
|
-
"value": {
|
|
2124
|
-
"type": "'small' | 'medium' | 'large'",
|
|
2125
|
-
"default": "'medium'"
|
|
2126
|
-
}
|
|
2127
|
-
},
|
|
2128
|
-
{
|
|
2129
|
-
"name": "disabled",
|
|
2130
|
-
"description": "Disables the switch.",
|
|
2131
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2132
|
-
},
|
|
2133
|
-
{
|
|
2134
|
-
"name": "checked",
|
|
2135
|
-
"description": "Draws the switch in a checked state.",
|
|
2136
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2137
|
-
},
|
|
2138
|
-
{
|
|
2139
|
-
"name": "form",
|
|
2140
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
2141
|
-
"value": { "type": "string", "default": "''" }
|
|
2142
|
-
},
|
|
2143
|
-
{
|
|
2144
|
-
"name": "required",
|
|
2145
|
-
"description": "Makes the switch a required field.",
|
|
2146
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2147
|
-
}
|
|
2148
|
-
],
|
|
2149
|
-
"slots": [{ "name": "", "description": "The switch's label." }],
|
|
2150
|
-
"events": [
|
|
2151
|
-
{
|
|
2152
|
-
"name": "syn-blur",
|
|
2153
|
-
"description": "Emitted when the control loses focus."
|
|
2154
|
-
},
|
|
2155
|
-
{
|
|
2156
|
-
"name": "syn-change",
|
|
2157
|
-
"description": "Emitted when the control's checked state changes."
|
|
2158
|
-
},
|
|
2159
|
-
{
|
|
2160
|
-
"name": "syn-input",
|
|
2161
|
-
"description": "Emitted when the control receives input."
|
|
2162
|
-
},
|
|
2163
|
-
{
|
|
2164
|
-
"name": "syn-focus",
|
|
2165
|
-
"description": "Emitted when the control gains focus."
|
|
2166
|
-
},
|
|
2167
|
-
{
|
|
2168
|
-
"name": "syn-invalid",
|
|
2169
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
2170
|
-
}
|
|
2171
|
-
],
|
|
2172
|
-
"js": {
|
|
2173
|
-
"properties": [
|
|
2174
|
-
{ "name": "title", "value": { "type": "string" } },
|
|
2175
|
-
{
|
|
2176
|
-
"name": "name",
|
|
2177
|
-
"description": "The name of the switch, submitted as a name/value pair with form data.",
|
|
2178
|
-
"value": { "type": "string" }
|
|
2179
|
-
},
|
|
2180
|
-
{
|
|
2181
|
-
"name": "value",
|
|
2182
|
-
"description": "The current value of the switch, submitted as a name/value pair with form data.",
|
|
2183
|
-
"value": { "type": "string" }
|
|
2184
|
-
},
|
|
2185
|
-
{
|
|
2186
|
-
"name": "size",
|
|
2187
|
-
"description": "The switch's size.",
|
|
2188
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
2189
|
-
},
|
|
2190
|
-
{
|
|
2191
|
-
"name": "disabled",
|
|
2192
|
-
"description": "Disables the switch.",
|
|
2193
|
-
"value": { "type": "boolean" }
|
|
2194
|
-
},
|
|
2195
|
-
{
|
|
2196
|
-
"name": "checked",
|
|
2197
|
-
"description": "Draws the switch in a checked state.",
|
|
2198
|
-
"value": { "type": "boolean" }
|
|
2199
|
-
},
|
|
2200
|
-
{
|
|
2201
|
-
"name": "form",
|
|
2202
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
2203
|
-
"value": { "type": "string" }
|
|
2204
|
-
},
|
|
2205
|
-
{
|
|
2206
|
-
"name": "required",
|
|
2207
|
-
"description": "Makes the switch a required field.",
|
|
2208
|
-
"value": { "type": "boolean" }
|
|
2209
|
-
}
|
|
2210
|
-
],
|
|
2211
|
-
"events": [
|
|
2212
|
-
{
|
|
2213
|
-
"name": "syn-blur",
|
|
2214
|
-
"description": "Emitted when the control loses focus."
|
|
2215
|
-
},
|
|
2216
|
-
{
|
|
2217
|
-
"name": "syn-change",
|
|
2218
|
-
"description": "Emitted when the control's checked state changes."
|
|
2219
|
-
},
|
|
2220
|
-
{
|
|
2221
|
-
"name": "syn-input",
|
|
2222
|
-
"description": "Emitted when the control receives input."
|
|
2223
|
-
},
|
|
2224
|
-
{
|
|
2225
|
-
"name": "syn-focus",
|
|
2226
|
-
"description": "Emitted when the control gains focus."
|
|
2227
|
-
},
|
|
2228
|
-
{
|
|
2229
|
-
"name": "syn-invalid",
|
|
2230
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
2231
|
-
}
|
|
2232
|
-
]
|
|
2233
|
-
}
|
|
2234
|
-
},
|
|
2235
|
-
{
|
|
2236
|
-
"name": "syn-tag",
|
|
2237
|
-
"description": "Tags are used as labels to organize things or to indicate a selection.\n---\n\n\n### **Events:**\n - **syn-remove** - Emitted when the remove button is activated.\n\n### **Slots:**\n - _default_ - The tag's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **content** - The tag's content.\n- **remove-button** - The tag's remove button, an `<syn-icon-button>`.\n- **remove-button__base** - The remove button's exported `base` part.",
|
|
2238
|
-
"doc-url": "",
|
|
2239
|
-
"attributes": [
|
|
2240
|
-
{
|
|
2241
|
-
"name": "size",
|
|
2242
|
-
"description": "The tag's size.",
|
|
2243
|
-
"value": {
|
|
2244
|
-
"type": "'small' | 'medium' | 'large'",
|
|
2245
|
-
"default": "'medium'"
|
|
2246
|
-
}
|
|
2247
|
-
},
|
|
2248
|
-
{
|
|
2249
|
-
"name": "removable",
|
|
2250
|
-
"description": "Makes the tag removable and shows a remove button.",
|
|
2251
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2252
|
-
}
|
|
2253
|
-
],
|
|
2254
|
-
"slots": [{ "name": "", "description": "The tag's content." }],
|
|
2255
|
-
"events": [
|
|
2256
|
-
{
|
|
2257
|
-
"name": "syn-remove",
|
|
2258
|
-
"description": "Emitted when the remove button is activated."
|
|
2259
|
-
}
|
|
2260
|
-
],
|
|
2261
|
-
"js": {
|
|
2262
|
-
"properties": [
|
|
2263
|
-
{
|
|
2264
|
-
"name": "size",
|
|
2265
|
-
"description": "The tag's size.",
|
|
2266
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
2267
|
-
},
|
|
2268
|
-
{
|
|
2269
|
-
"name": "removable",
|
|
2270
|
-
"description": "Makes the tag removable and shows a remove button.",
|
|
2271
|
-
"value": { "type": "boolean" }
|
|
2272
|
-
}
|
|
2273
|
-
],
|
|
2274
|
-
"events": [
|
|
2275
|
-
{
|
|
2276
|
-
"name": "syn-remove",
|
|
2277
|
-
"description": "Emitted when the remove button is activated."
|
|
2278
|
-
}
|
|
2279
|
-
]
|
|
2280
|
-
}
|
|
2281
|
-
},
|
|
2282
|
-
{
|
|
2283
|
-
"name": "syn-textarea",
|
|
2284
|
-
"description": "Textareas collect data from the user and allow multiple lines of text.\n---\n\n\n### **Events:**\n - **syn-blur** - Emitted when the control loses focus.\n- **syn-change** - Emitted when an alteration to the control's value is committed by the user.\n- **syn-focus** - Emitted when the control gains focus.\n- **syn-input** - Emitted when the control receives input.\n- **syn-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the textarea.\n- **blur()** - Removes focus from the textarea.\n- **select()** - Selects all the text in the textarea.\n- **scrollPosition(position: _{ top?: number; left?: number }_): _{ top: number; left: number } | undefined_** - Gets or sets the textarea's scroll position.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - **label** - The textarea's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The input's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **textarea** - The internal `<textarea>` control.",
|
|
2285
|
-
"doc-url": "",
|
|
2286
|
-
"attributes": [
|
|
2287
|
-
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
|
2288
|
-
{
|
|
2289
|
-
"name": "name",
|
|
2290
|
-
"description": "The name of the textarea, submitted as a name/value pair with form data.",
|
|
2291
|
-
"value": { "type": "string", "default": "''" }
|
|
2292
|
-
},
|
|
2293
|
-
{
|
|
2294
|
-
"name": "value",
|
|
2295
|
-
"description": "The current value of the textarea, submitted as a name/value pair with form data.",
|
|
2296
|
-
"value": { "type": "string", "default": "''" }
|
|
2297
|
-
},
|
|
2298
|
-
{
|
|
2299
|
-
"name": "size",
|
|
2300
|
-
"description": "The textarea's size.",
|
|
2301
|
-
"value": {
|
|
2302
|
-
"type": "'small' | 'medium' | 'large'",
|
|
2303
|
-
"default": "'medium'"
|
|
2304
|
-
}
|
|
2305
|
-
},
|
|
2306
|
-
{
|
|
2307
|
-
"name": "label",
|
|
2308
|
-
"description": "The textarea's label. If you need to display HTML, use the `label` slot instead.",
|
|
2309
|
-
"value": { "type": "string", "default": "''" }
|
|
2310
|
-
},
|
|
2311
|
-
{
|
|
2312
|
-
"name": "help-text",
|
|
2313
|
-
"description": "The textarea's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
2314
|
-
"value": { "type": "string", "default": "''" }
|
|
2315
|
-
},
|
|
2316
|
-
{
|
|
2317
|
-
"name": "placeholder",
|
|
2318
|
-
"description": "Placeholder text to show as a hint when the input is empty.",
|
|
2319
|
-
"value": { "type": "string", "default": "''" }
|
|
2320
|
-
},
|
|
2321
|
-
{
|
|
2322
|
-
"name": "rows",
|
|
2323
|
-
"description": "The number of rows to display by default.",
|
|
2324
|
-
"value": { "type": "number", "default": "4" }
|
|
2325
|
-
},
|
|
2326
|
-
{
|
|
2327
|
-
"name": "resize",
|
|
2328
|
-
"description": "Controls how the textarea can be resized.",
|
|
2329
|
-
"value": {
|
|
2330
|
-
"type": "'none' | 'vertical' | 'auto'",
|
|
2331
|
-
"default": "'vertical'"
|
|
2332
|
-
}
|
|
2333
|
-
},
|
|
2334
|
-
{
|
|
2335
|
-
"name": "disabled",
|
|
2336
|
-
"description": "Disables the textarea.",
|
|
2337
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2338
|
-
},
|
|
2339
|
-
{
|
|
2340
|
-
"name": "readonly",
|
|
2341
|
-
"description": "Makes the textarea readonly.",
|
|
2342
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2343
|
-
},
|
|
2344
|
-
{
|
|
2345
|
-
"name": "form",
|
|
2346
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
2347
|
-
"value": { "type": "string", "default": "''" }
|
|
2348
|
-
},
|
|
2349
|
-
{
|
|
2350
|
-
"name": "required",
|
|
2351
|
-
"description": "Makes the textarea a required field.",
|
|
2352
|
-
"value": { "type": "boolean", "default": "false" }
|
|
2353
|
-
},
|
|
2354
|
-
{
|
|
2355
|
-
"name": "minlength",
|
|
2356
|
-
"description": "The minimum length of input that will be considered valid.",
|
|
2357
|
-
"value": { "type": "number" }
|
|
2358
|
-
},
|
|
2359
|
-
{
|
|
2360
|
-
"name": "maxlength",
|
|
2361
|
-
"description": "The maximum length of input that will be considered valid.",
|
|
2362
|
-
"value": { "type": "number" }
|
|
2363
|
-
},
|
|
2364
|
-
{
|
|
2365
|
-
"name": "autocapitalize",
|
|
2366
|
-
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
|
2367
|
-
"value": {
|
|
2368
|
-
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
|
2369
|
-
}
|
|
2370
|
-
},
|
|
2371
|
-
{
|
|
2372
|
-
"name": "autocorrect",
|
|
2373
|
-
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
|
2374
|
-
"value": { "type": "string" }
|
|
2375
|
-
},
|
|
2376
|
-
{
|
|
2377
|
-
"name": "autocomplete",
|
|
2378
|
-
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
|
2379
|
-
"value": { "type": "string" }
|
|
2380
|
-
},
|
|
2381
|
-
{
|
|
2382
|
-
"name": "autofocus",
|
|
2383
|
-
"description": "Indicates that the input should receive focus on page load.",
|
|
2384
|
-
"value": { "type": "boolean" }
|
|
2385
|
-
},
|
|
2386
|
-
{
|
|
2387
|
-
"name": "enterkeyhint",
|
|
2388
|
-
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
|
2389
|
-
"value": {
|
|
2390
|
-
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
|
2391
|
-
}
|
|
2392
|
-
},
|
|
2393
|
-
{
|
|
2394
|
-
"name": "spellcheck",
|
|
2395
|
-
"description": "Enables spell checking on the textarea.",
|
|
2396
|
-
"value": { "type": "boolean", "default": "true" }
|
|
2397
|
-
},
|
|
2398
|
-
{
|
|
2399
|
-
"name": "inputmode",
|
|
2400
|
-
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
|
2401
|
-
"value": {
|
|
2402
|
-
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
|
2403
|
-
}
|
|
2404
|
-
}
|
|
2405
|
-
],
|
|
2406
|
-
"slots": [
|
|
2407
|
-
{
|
|
2408
|
-
"name": "label",
|
|
2409
|
-
"description": "The textarea's label. Alternatively, you can use the `label` attribute."
|
|
2410
|
-
},
|
|
2411
|
-
{
|
|
2412
|
-
"name": "help-text",
|
|
2413
|
-
"description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute."
|
|
2414
|
-
}
|
|
2415
|
-
],
|
|
2416
|
-
"events": [
|
|
2417
|
-
{
|
|
2418
|
-
"name": "syn-blur",
|
|
2419
|
-
"description": "Emitted when the control loses focus."
|
|
2420
|
-
},
|
|
2421
|
-
{
|
|
2422
|
-
"name": "syn-change",
|
|
2423
|
-
"description": "Emitted when an alteration to the control's value is committed by the user."
|
|
2424
|
-
},
|
|
2425
|
-
{
|
|
2426
|
-
"name": "syn-focus",
|
|
2427
|
-
"description": "Emitted when the control gains focus."
|
|
2428
|
-
},
|
|
2429
|
-
{
|
|
2430
|
-
"name": "syn-input",
|
|
2431
|
-
"description": "Emitted when the control receives input."
|
|
2432
|
-
},
|
|
2433
|
-
{
|
|
2434
|
-
"name": "syn-invalid",
|
|
2435
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
2436
|
-
}
|
|
2437
|
-
],
|
|
2438
|
-
"js": {
|
|
2439
|
-
"properties": [
|
|
2440
|
-
{ "name": "title", "value": { "type": "string" } },
|
|
2441
|
-
{
|
|
2442
|
-
"name": "name",
|
|
2443
|
-
"description": "The name of the textarea, submitted as a name/value pair with form data.",
|
|
2444
|
-
"value": { "type": "string" }
|
|
2445
|
-
},
|
|
2446
|
-
{
|
|
2447
|
-
"name": "value",
|
|
2448
|
-
"description": "The current value of the textarea, submitted as a name/value pair with form data.",
|
|
2449
|
-
"value": { "type": "string" }
|
|
2450
|
-
},
|
|
2451
|
-
{
|
|
2452
|
-
"name": "size",
|
|
2453
|
-
"description": "The textarea's size.",
|
|
2454
|
-
"value": { "type": "'small' | 'medium' | 'large'" }
|
|
2455
|
-
},
|
|
2456
|
-
{
|
|
2457
|
-
"name": "label",
|
|
2458
|
-
"description": "The textarea's label. If you need to display HTML, use the `label` slot instead.",
|
|
2459
|
-
"value": { "type": "string" }
|
|
2460
|
-
},
|
|
2461
|
-
{
|
|
2462
|
-
"name": "help-text",
|
|
2463
|
-
"description": "The textarea's help text. If you need to display HTML, use the `help-text` slot instead.",
|
|
2464
|
-
"value": { "type": "string" }
|
|
2465
|
-
},
|
|
2466
|
-
{
|
|
2467
|
-
"name": "placeholder",
|
|
2468
|
-
"description": "Placeholder text to show as a hint when the input is empty.",
|
|
2469
|
-
"value": { "type": "string" }
|
|
2470
|
-
},
|
|
2471
|
-
{
|
|
2472
|
-
"name": "rows",
|
|
2473
|
-
"description": "The number of rows to display by default.",
|
|
2474
|
-
"value": { "type": "number" }
|
|
2475
|
-
},
|
|
2476
|
-
{
|
|
2477
|
-
"name": "resize",
|
|
2478
|
-
"description": "Controls how the textarea can be resized.",
|
|
2479
|
-
"value": { "type": "'none' | 'vertical' | 'auto'" }
|
|
2480
|
-
},
|
|
2481
|
-
{
|
|
2482
|
-
"name": "disabled",
|
|
2483
|
-
"description": "Disables the textarea.",
|
|
2484
|
-
"value": { "type": "boolean" }
|
|
2485
|
-
},
|
|
2486
|
-
{
|
|
2487
|
-
"name": "readonly",
|
|
2488
|
-
"description": "Makes the textarea readonly.",
|
|
2489
|
-
"value": { "type": "boolean" }
|
|
2490
|
-
},
|
|
2491
|
-
{
|
|
2492
|
-
"name": "form",
|
|
2493
|
-
"description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
|
|
2494
|
-
"value": { "type": "string" }
|
|
2495
|
-
},
|
|
2496
|
-
{
|
|
2497
|
-
"name": "required",
|
|
2498
|
-
"description": "Makes the textarea a required field.",
|
|
2499
|
-
"value": { "type": "boolean" }
|
|
2500
|
-
},
|
|
2501
|
-
{
|
|
2502
|
-
"name": "minlength",
|
|
2503
|
-
"description": "The minimum length of input that will be considered valid.",
|
|
2504
|
-
"value": { "type": "number" }
|
|
2505
|
-
},
|
|
2506
|
-
{
|
|
2507
|
-
"name": "maxlength",
|
|
2508
|
-
"description": "The maximum length of input that will be considered valid.",
|
|
2509
|
-
"value": { "type": "number" }
|
|
2510
|
-
},
|
|
2511
|
-
{
|
|
2512
|
-
"name": "autocapitalize",
|
|
2513
|
-
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
|
2514
|
-
"value": {
|
|
2515
|
-
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
|
2516
|
-
}
|
|
2517
|
-
},
|
|
2518
|
-
{
|
|
2519
|
-
"name": "autocorrect",
|
|
2520
|
-
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
|
2521
|
-
"value": { "type": "string" }
|
|
2522
|
-
},
|
|
2523
|
-
{
|
|
2524
|
-
"name": "autocomplete",
|
|
2525
|
-
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
|
2526
|
-
"value": { "type": "string" }
|
|
2527
|
-
},
|
|
2528
|
-
{
|
|
2529
|
-
"name": "autofocus",
|
|
2530
|
-
"description": "Indicates that the input should receive focus on page load.",
|
|
2531
|
-
"value": { "type": "boolean" }
|
|
2532
|
-
},
|
|
2533
|
-
{
|
|
2534
|
-
"name": "enterkeyhint",
|
|
2535
|
-
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
|
2536
|
-
"value": {
|
|
2537
|
-
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
|
2538
|
-
}
|
|
2539
|
-
},
|
|
2540
|
-
{
|
|
2541
|
-
"name": "spellcheck",
|
|
2542
|
-
"description": "Enables spell checking on the textarea.",
|
|
2543
|
-
"value": { "type": "boolean" }
|
|
2544
|
-
},
|
|
2545
|
-
{
|
|
2546
|
-
"name": "inputmode",
|
|
2547
|
-
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
|
2548
|
-
"value": {
|
|
2549
|
-
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
|
2550
|
-
}
|
|
2551
|
-
}
|
|
2552
|
-
],
|
|
2553
|
-
"events": [
|
|
2554
|
-
{
|
|
2555
|
-
"name": "syn-blur",
|
|
2556
|
-
"description": "Emitted when the control loses focus."
|
|
2557
|
-
},
|
|
2558
|
-
{
|
|
2559
|
-
"name": "syn-change",
|
|
2560
|
-
"description": "Emitted when an alteration to the control's value is committed by the user."
|
|
2561
|
-
},
|
|
2562
|
-
{
|
|
2563
|
-
"name": "syn-focus",
|
|
2564
|
-
"description": "Emitted when the control gains focus."
|
|
2565
|
-
},
|
|
2566
|
-
{
|
|
2567
|
-
"name": "syn-input",
|
|
2568
|
-
"description": "Emitted when the control receives input."
|
|
2569
|
-
},
|
|
2570
|
-
{
|
|
2571
|
-
"name": "syn-invalid",
|
|
2572
|
-
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
|
2573
|
-
}
|
|
2574
|
-
]
|
|
2575
|
-
}
|
|
2576
|
-
}
|
|
2577
|
-
]
|
|
2578
|
-
}
|
|
2579
|
-
}
|
|
2580
|
-
}
|