@nordhealth/components 4.12.8 → 4.12.9
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/custom-elements.json +1268 -1268
- package/lib/IconManager.js +1 -1
- package/lib/bundle.js +1 -1
- package/package.json +3 -3
package/custom-elements.json
CHANGED
|
@@ -681,6 +681,91 @@
|
|
|
681
681
|
}
|
|
682
682
|
]
|
|
683
683
|
},
|
|
684
|
+
{
|
|
685
|
+
"kind": "javascript-module",
|
|
686
|
+
"path": "src/banner/Banner.ts",
|
|
687
|
+
"declarations": [
|
|
688
|
+
{
|
|
689
|
+
"kind": "class",
|
|
690
|
+
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
691
|
+
"name": "Banner",
|
|
692
|
+
"cssProperties": [
|
|
693
|
+
{
|
|
694
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
695
|
+
"name": "--n-banner-border-radius",
|
|
696
|
+
"default": "var(--n-border-radius)"
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
700
|
+
"name": "--n-banner-box-shadow",
|
|
701
|
+
"default": "var(--n-box-shadow-card)"
|
|
702
|
+
}
|
|
703
|
+
],
|
|
704
|
+
"slots": [
|
|
705
|
+
{
|
|
706
|
+
"description": "default slot",
|
|
707
|
+
"name": ""
|
|
708
|
+
}
|
|
709
|
+
],
|
|
710
|
+
"members": [
|
|
711
|
+
{
|
|
712
|
+
"kind": "field",
|
|
713
|
+
"name": "variant",
|
|
714
|
+
"type": {
|
|
715
|
+
"text": "'info' | 'danger' | 'success' | 'warning'"
|
|
716
|
+
},
|
|
717
|
+
"default": "'info'",
|
|
718
|
+
"description": "The style variant of the banner.",
|
|
719
|
+
"attribute": "variant",
|
|
720
|
+
"reflects": true
|
|
721
|
+
}
|
|
722
|
+
],
|
|
723
|
+
"attributes": [
|
|
724
|
+
{
|
|
725
|
+
"name": "variant",
|
|
726
|
+
"type": {
|
|
727
|
+
"text": "'info' | 'danger' | 'success' | 'warning'"
|
|
728
|
+
},
|
|
729
|
+
"default": "'info'",
|
|
730
|
+
"description": "The style variant of the banner.",
|
|
731
|
+
"fieldName": "variant"
|
|
732
|
+
}
|
|
733
|
+
],
|
|
734
|
+
"superclass": {
|
|
735
|
+
"name": "LitElement",
|
|
736
|
+
"package": "lit"
|
|
737
|
+
},
|
|
738
|
+
"localization": [],
|
|
739
|
+
"status": "ready",
|
|
740
|
+
"category": "feedback",
|
|
741
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
742
|
+
"examples": [],
|
|
743
|
+
"dependencies": [
|
|
744
|
+
"icon"
|
|
745
|
+
],
|
|
746
|
+
"tagName": "nord-banner",
|
|
747
|
+
"customElement": true
|
|
748
|
+
}
|
|
749
|
+
],
|
|
750
|
+
"exports": [
|
|
751
|
+
{
|
|
752
|
+
"kind": "js",
|
|
753
|
+
"name": "default",
|
|
754
|
+
"declaration": {
|
|
755
|
+
"name": "Banner",
|
|
756
|
+
"module": "src/banner/Banner.ts"
|
|
757
|
+
}
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
"kind": "custom-element-definition",
|
|
761
|
+
"name": "nord-banner",
|
|
762
|
+
"declaration": {
|
|
763
|
+
"name": "Banner",
|
|
764
|
+
"module": "src/banner/Banner.ts"
|
|
765
|
+
}
|
|
766
|
+
}
|
|
767
|
+
]
|
|
768
|
+
},
|
|
684
769
|
{
|
|
685
770
|
"kind": "javascript-module",
|
|
686
771
|
"path": "src/badge/Badge.ts",
|
|
@@ -798,91 +883,6 @@
|
|
|
798
883
|
}
|
|
799
884
|
]
|
|
800
885
|
},
|
|
801
|
-
{
|
|
802
|
-
"kind": "javascript-module",
|
|
803
|
-
"path": "src/banner/Banner.ts",
|
|
804
|
-
"declarations": [
|
|
805
|
-
{
|
|
806
|
-
"kind": "class",
|
|
807
|
-
"description": "Banner informs users about important changes or conditions in the\ninterface. Use this component if you need to communicate to users\nin a prominent way.",
|
|
808
|
-
"name": "Banner",
|
|
809
|
-
"cssProperties": [
|
|
810
|
-
{
|
|
811
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
812
|
-
"name": "--n-banner-border-radius",
|
|
813
|
-
"default": "var(--n-border-radius)"
|
|
814
|
-
},
|
|
815
|
-
{
|
|
816
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
817
|
-
"name": "--n-banner-box-shadow",
|
|
818
|
-
"default": "var(--n-box-shadow-card)"
|
|
819
|
-
}
|
|
820
|
-
],
|
|
821
|
-
"slots": [
|
|
822
|
-
{
|
|
823
|
-
"description": "default slot",
|
|
824
|
-
"name": ""
|
|
825
|
-
}
|
|
826
|
-
],
|
|
827
|
-
"members": [
|
|
828
|
-
{
|
|
829
|
-
"kind": "field",
|
|
830
|
-
"name": "variant",
|
|
831
|
-
"type": {
|
|
832
|
-
"text": "'info' | 'danger' | 'success' | 'warning'"
|
|
833
|
-
},
|
|
834
|
-
"default": "'info'",
|
|
835
|
-
"description": "The style variant of the banner.",
|
|
836
|
-
"attribute": "variant",
|
|
837
|
-
"reflects": true
|
|
838
|
-
}
|
|
839
|
-
],
|
|
840
|
-
"attributes": [
|
|
841
|
-
{
|
|
842
|
-
"name": "variant",
|
|
843
|
-
"type": {
|
|
844
|
-
"text": "'info' | 'danger' | 'success' | 'warning'"
|
|
845
|
-
},
|
|
846
|
-
"default": "'info'",
|
|
847
|
-
"description": "The style variant of the banner.",
|
|
848
|
-
"fieldName": "variant"
|
|
849
|
-
}
|
|
850
|
-
],
|
|
851
|
-
"superclass": {
|
|
852
|
-
"name": "LitElement",
|
|
853
|
-
"package": "lit"
|
|
854
|
-
},
|
|
855
|
-
"localization": [],
|
|
856
|
-
"status": "ready",
|
|
857
|
-
"category": "feedback",
|
|
858
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use this component if you need to communicate in a prominent way.\n- Place banner at the top of the section it applies to.\n- Use for highlighting errors and success statuses.\n- Put banner close to the context it’s referring to.\n- Move focus to the banner if it’s relevant to the current workflow.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Move focus to banner if it appears on page load.\n- Use for highlighting general content or as a banner.\n- Use to replace an error page.\n\n</div>\n\n---\n\n## Content guidelines\n\nBanner content should be clear, accurate and easy to understand:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident. Please see our status page for more details.</div>\n<div class=\"n-usage n-usage-dont\">There was an error.</div>\n\nWhen writing banner content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re Experiencing An Incident.</div>\n\nAlways end in punctuation:\n\n<div class=\"n-usage n-usage-do\">We’re experiencing an incident.</div>\n<div class=\"n-usage n-usage-dont\">We’re experiencing an incident</div>\n",
|
|
859
|
-
"examples": [],
|
|
860
|
-
"dependencies": [
|
|
861
|
-
"icon"
|
|
862
|
-
],
|
|
863
|
-
"tagName": "nord-banner",
|
|
864
|
-
"customElement": true
|
|
865
|
-
}
|
|
866
|
-
],
|
|
867
|
-
"exports": [
|
|
868
|
-
{
|
|
869
|
-
"kind": "js",
|
|
870
|
-
"name": "default",
|
|
871
|
-
"declaration": {
|
|
872
|
-
"name": "Banner",
|
|
873
|
-
"module": "src/banner/Banner.ts"
|
|
874
|
-
}
|
|
875
|
-
},
|
|
876
|
-
{
|
|
877
|
-
"kind": "custom-element-definition",
|
|
878
|
-
"name": "nord-banner",
|
|
879
|
-
"declaration": {
|
|
880
|
-
"name": "Banner",
|
|
881
|
-
"module": "src/banner/Banner.ts"
|
|
882
|
-
}
|
|
883
|
-
}
|
|
884
|
-
]
|
|
885
|
-
},
|
|
886
886
|
{
|
|
887
887
|
"kind": "javascript-module",
|
|
888
888
|
"path": "src/button/Button.ts",
|
|
@@ -2200,192 +2200,64 @@
|
|
|
2200
2200
|
},
|
|
2201
2201
|
{
|
|
2202
2202
|
"kind": "javascript-module",
|
|
2203
|
-
"path": "src/
|
|
2203
|
+
"path": "src/checkbox/Checkbox.ts",
|
|
2204
2204
|
"declarations": [
|
|
2205
2205
|
{
|
|
2206
2206
|
"kind": "class",
|
|
2207
|
-
"description": "
|
|
2208
|
-
"name": "
|
|
2207
|
+
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
2208
|
+
"name": "Checkbox",
|
|
2209
2209
|
"cssProperties": [
|
|
2210
2210
|
{
|
|
2211
|
-
"description": "Controls
|
|
2212
|
-
"name": "--n-
|
|
2213
|
-
"default": "var(--n-
|
|
2214
|
-
},
|
|
2215
|
-
{
|
|
2216
|
-
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
2217
|
-
"name": "--n-card-box-shadow",
|
|
2218
|
-
"default": "var(--n-box-shadow-popout)"
|
|
2219
|
-
},
|
|
2220
|
-
{
|
|
2221
|
-
"description": "Controls the padding on all sides of the card.",
|
|
2222
|
-
"name": "--n-card-padding",
|
|
2223
|
-
"default": "var(--n-space-m)"
|
|
2224
|
-
},
|
|
2225
|
-
{
|
|
2226
|
-
"description": "Controls the padding of items slotted within the card. This does not affect the block padding of items slotted into the header.",
|
|
2227
|
-
"name": "--n-card-slot-padding",
|
|
2228
|
-
"default": "var(--n-space-m)"
|
|
2229
|
-
},
|
|
2230
|
-
{
|
|
2231
|
-
"description": "Controls the background color of the card header.",
|
|
2232
|
-
"name": "--n-card-header-background",
|
|
2233
|
-
"default": "transparent"
|
|
2211
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
2212
|
+
"name": "--n-label-color",
|
|
2213
|
+
"default": "var(--n-color-text)"
|
|
2234
2214
|
}
|
|
2235
2215
|
],
|
|
2236
2216
|
"slots": [
|
|
2237
2217
|
{
|
|
2238
|
-
"description": "
|
|
2239
|
-
"name": ""
|
|
2240
|
-
},
|
|
2241
|
-
{
|
|
2242
|
-
"description": "Optional slot that holds a header for the card.",
|
|
2243
|
-
"name": "header"
|
|
2218
|
+
"description": "Use when a label requires more than plain text.",
|
|
2219
|
+
"name": "label"
|
|
2244
2220
|
},
|
|
2245
2221
|
{
|
|
2246
|
-
"description": "Optional slot that
|
|
2247
|
-
"name": "
|
|
2222
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
2223
|
+
"name": "hint"
|
|
2248
2224
|
},
|
|
2249
2225
|
{
|
|
2250
|
-
"description": "Optional slot that holds
|
|
2251
|
-
"name": "
|
|
2226
|
+
"description": "Optional slot that holds error text for the input.",
|
|
2227
|
+
"name": "error"
|
|
2252
2228
|
}
|
|
2253
2229
|
],
|
|
2254
2230
|
"members": [
|
|
2255
2231
|
{
|
|
2256
2232
|
"kind": "field",
|
|
2257
|
-
"name": "
|
|
2258
|
-
"privacy": "
|
|
2259
|
-
"
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
"privacy": "private",
|
|
2265
|
-
"default": "new SlotController(this, 'header-end')"
|
|
2233
|
+
"name": "formValue",
|
|
2234
|
+
"privacy": "protected",
|
|
2235
|
+
"readonly": true,
|
|
2236
|
+
"inheritedFrom": {
|
|
2237
|
+
"name": "FormAssociatedMixin",
|
|
2238
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2239
|
+
}
|
|
2266
2240
|
},
|
|
2267
2241
|
{
|
|
2268
2242
|
"kind": "field",
|
|
2269
|
-
"name": "
|
|
2270
|
-
"
|
|
2271
|
-
|
|
2243
|
+
"name": "indeterminate",
|
|
2244
|
+
"type": {
|
|
2245
|
+
"text": "boolean"
|
|
2246
|
+
},
|
|
2247
|
+
"default": "false",
|
|
2248
|
+
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
2249
|
+
"attribute": "indeterminate",
|
|
2250
|
+
"reflects": true
|
|
2272
2251
|
},
|
|
2273
2252
|
{
|
|
2274
2253
|
"kind": "field",
|
|
2275
|
-
"name": "
|
|
2254
|
+
"name": "checked",
|
|
2276
2255
|
"type": {
|
|
2277
|
-
"text": "
|
|
2256
|
+
"text": "boolean"
|
|
2278
2257
|
},
|
|
2279
|
-
"default": "
|
|
2280
|
-
"description": "Controls
|
|
2281
|
-
"attribute": "
|
|
2282
|
-
"reflects": true
|
|
2283
|
-
}
|
|
2284
|
-
],
|
|
2285
|
-
"attributes": [
|
|
2286
|
-
{
|
|
2287
|
-
"name": "padding",
|
|
2288
|
-
"type": {
|
|
2289
|
-
"text": "'m' | 'l' | 'none'"
|
|
2290
|
-
},
|
|
2291
|
-
"default": "'m'",
|
|
2292
|
-
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
2293
|
-
"fieldName": "padding"
|
|
2294
|
-
}
|
|
2295
|
-
],
|
|
2296
|
-
"superclass": {
|
|
2297
|
-
"name": "LitElement",
|
|
2298
|
-
"package": "lit"
|
|
2299
|
-
},
|
|
2300
|
-
"localization": [],
|
|
2301
|
-
"status": "ready",
|
|
2302
|
-
"category": "structure",
|
|
2303
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n- Include a header when placing a [Table](/components/table) component inside the card.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place cards within cards. Consider using the [divider](/components/divider/) component to break up sections instead.\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n",
|
|
2304
|
-
"examples": [],
|
|
2305
|
-
"dependencies": [],
|
|
2306
|
-
"tagName": "nord-card",
|
|
2307
|
-
"customElement": true
|
|
2308
|
-
}
|
|
2309
|
-
],
|
|
2310
|
-
"exports": [
|
|
2311
|
-
{
|
|
2312
|
-
"kind": "js",
|
|
2313
|
-
"name": "default",
|
|
2314
|
-
"declaration": {
|
|
2315
|
-
"name": "Card",
|
|
2316
|
-
"module": "src/card/Card.ts"
|
|
2317
|
-
}
|
|
2318
|
-
},
|
|
2319
|
-
{
|
|
2320
|
-
"kind": "custom-element-definition",
|
|
2321
|
-
"name": "nord-card",
|
|
2322
|
-
"declaration": {
|
|
2323
|
-
"name": "Card",
|
|
2324
|
-
"module": "src/card/Card.ts"
|
|
2325
|
-
}
|
|
2326
|
-
}
|
|
2327
|
-
]
|
|
2328
|
-
},
|
|
2329
|
-
{
|
|
2330
|
-
"kind": "javascript-module",
|
|
2331
|
-
"path": "src/checkbox/Checkbox.ts",
|
|
2332
|
-
"declarations": [
|
|
2333
|
-
{
|
|
2334
|
-
"kind": "class",
|
|
2335
|
-
"description": "Checkboxes allow user to choose one or more options from a limited set of options.\nIf you have more than 10 options, please use Select component instead.",
|
|
2336
|
-
"name": "Checkbox",
|
|
2337
|
-
"cssProperties": [
|
|
2338
|
-
{
|
|
2339
|
-
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
2340
|
-
"name": "--n-label-color",
|
|
2341
|
-
"default": "var(--n-color-text)"
|
|
2342
|
-
}
|
|
2343
|
-
],
|
|
2344
|
-
"slots": [
|
|
2345
|
-
{
|
|
2346
|
-
"description": "Use when a label requires more than plain text.",
|
|
2347
|
-
"name": "label"
|
|
2348
|
-
},
|
|
2349
|
-
{
|
|
2350
|
-
"description": "Optional slot that holds hint text for the input.",
|
|
2351
|
-
"name": "hint"
|
|
2352
|
-
},
|
|
2353
|
-
{
|
|
2354
|
-
"description": "Optional slot that holds error text for the input.",
|
|
2355
|
-
"name": "error"
|
|
2356
|
-
}
|
|
2357
|
-
],
|
|
2358
|
-
"members": [
|
|
2359
|
-
{
|
|
2360
|
-
"kind": "field",
|
|
2361
|
-
"name": "formValue",
|
|
2362
|
-
"privacy": "protected",
|
|
2363
|
-
"readonly": true,
|
|
2364
|
-
"inheritedFrom": {
|
|
2365
|
-
"name": "FormAssociatedMixin",
|
|
2366
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
2367
|
-
}
|
|
2368
|
-
},
|
|
2369
|
-
{
|
|
2370
|
-
"kind": "field",
|
|
2371
|
-
"name": "indeterminate",
|
|
2372
|
-
"type": {
|
|
2373
|
-
"text": "boolean"
|
|
2374
|
-
},
|
|
2375
|
-
"default": "false",
|
|
2376
|
-
"description": "Controls whether the checkbox is in an indeterminate state.",
|
|
2377
|
-
"attribute": "indeterminate",
|
|
2378
|
-
"reflects": true
|
|
2379
|
-
},
|
|
2380
|
-
{
|
|
2381
|
-
"kind": "field",
|
|
2382
|
-
"name": "checked",
|
|
2383
|
-
"type": {
|
|
2384
|
-
"text": "boolean"
|
|
2385
|
-
},
|
|
2386
|
-
"default": "false",
|
|
2387
|
-
"description": "Controls whether the checkbox is checked or not.",
|
|
2388
|
-
"attribute": "checked",
|
|
2258
|
+
"default": "false",
|
|
2259
|
+
"description": "Controls whether the checkbox is checked or not.",
|
|
2260
|
+
"attribute": "checked",
|
|
2389
2261
|
"reflects": true
|
|
2390
2262
|
},
|
|
2391
2263
|
{
|
|
@@ -3064,6 +2936,134 @@
|
|
|
3064
2936
|
}
|
|
3065
2937
|
]
|
|
3066
2938
|
},
|
|
2939
|
+
{
|
|
2940
|
+
"kind": "javascript-module",
|
|
2941
|
+
"path": "src/card/Card.ts",
|
|
2942
|
+
"declarations": [
|
|
2943
|
+
{
|
|
2944
|
+
"kind": "class",
|
|
2945
|
+
"description": "Cards are shadowed surfaces that display content and actions on a\nsingle topic. They should be easy to scan for relevant and\nactionable information.",
|
|
2946
|
+
"name": "Card",
|
|
2947
|
+
"cssProperties": [
|
|
2948
|
+
{
|
|
2949
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
2950
|
+
"name": "--n-card-border-radius",
|
|
2951
|
+
"default": "var(--n-border-radius)"
|
|
2952
|
+
},
|
|
2953
|
+
{
|
|
2954
|
+
"description": "Controls the surrounding shadow, using [box shadow tokens](/tokens/#box-shadow).",
|
|
2955
|
+
"name": "--n-card-box-shadow",
|
|
2956
|
+
"default": "var(--n-box-shadow-popout)"
|
|
2957
|
+
},
|
|
2958
|
+
{
|
|
2959
|
+
"description": "Controls the padding on all sides of the card.",
|
|
2960
|
+
"name": "--n-card-padding",
|
|
2961
|
+
"default": "var(--n-space-m)"
|
|
2962
|
+
},
|
|
2963
|
+
{
|
|
2964
|
+
"description": "Controls the padding of items slotted within the card. This does not affect the block padding of items slotted into the header.",
|
|
2965
|
+
"name": "--n-card-slot-padding",
|
|
2966
|
+
"default": "var(--n-space-m)"
|
|
2967
|
+
},
|
|
2968
|
+
{
|
|
2969
|
+
"description": "Controls the background color of the card header.",
|
|
2970
|
+
"name": "--n-card-header-background",
|
|
2971
|
+
"default": "transparent"
|
|
2972
|
+
}
|
|
2973
|
+
],
|
|
2974
|
+
"slots": [
|
|
2975
|
+
{
|
|
2976
|
+
"description": "The card content.",
|
|
2977
|
+
"name": ""
|
|
2978
|
+
},
|
|
2979
|
+
{
|
|
2980
|
+
"description": "Optional slot that holds a header for the card.",
|
|
2981
|
+
"name": "header"
|
|
2982
|
+
},
|
|
2983
|
+
{
|
|
2984
|
+
"description": "Optional slot that positions content at the end of the header. Useful for actions or additional info.",
|
|
2985
|
+
"name": "header-end"
|
|
2986
|
+
},
|
|
2987
|
+
{
|
|
2988
|
+
"description": "Optional slot that holds footer content for the card.",
|
|
2989
|
+
"name": "footer"
|
|
2990
|
+
}
|
|
2991
|
+
],
|
|
2992
|
+
"members": [
|
|
2993
|
+
{
|
|
2994
|
+
"kind": "field",
|
|
2995
|
+
"name": "headerSlot",
|
|
2996
|
+
"privacy": "private",
|
|
2997
|
+
"default": "new SlotController(this, 'header')"
|
|
2998
|
+
},
|
|
2999
|
+
{
|
|
3000
|
+
"kind": "field",
|
|
3001
|
+
"name": "headerEndSlot",
|
|
3002
|
+
"privacy": "private",
|
|
3003
|
+
"default": "new SlotController(this, 'header-end')"
|
|
3004
|
+
},
|
|
3005
|
+
{
|
|
3006
|
+
"kind": "field",
|
|
3007
|
+
"name": "footerSlot",
|
|
3008
|
+
"privacy": "private",
|
|
3009
|
+
"default": "new SlotController(this, 'footer')"
|
|
3010
|
+
},
|
|
3011
|
+
{
|
|
3012
|
+
"kind": "field",
|
|
3013
|
+
"name": "padding",
|
|
3014
|
+
"type": {
|
|
3015
|
+
"text": "'m' | 'l' | 'none'"
|
|
3016
|
+
},
|
|
3017
|
+
"default": "'m'",
|
|
3018
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
3019
|
+
"attribute": "padding",
|
|
3020
|
+
"reflects": true
|
|
3021
|
+
}
|
|
3022
|
+
],
|
|
3023
|
+
"attributes": [
|
|
3024
|
+
{
|
|
3025
|
+
"name": "padding",
|
|
3026
|
+
"type": {
|
|
3027
|
+
"text": "'m' | 'l' | 'none'"
|
|
3028
|
+
},
|
|
3029
|
+
"default": "'m'",
|
|
3030
|
+
"description": "Controls the padding of the card component. When set to “none”,\nthe header and footer slots will still have padding.",
|
|
3031
|
+
"fieldName": "padding"
|
|
3032
|
+
}
|
|
3033
|
+
],
|
|
3034
|
+
"superclass": {
|
|
3035
|
+
"name": "LitElement",
|
|
3036
|
+
"package": "lit"
|
|
3037
|
+
},
|
|
3038
|
+
"localization": [],
|
|
3039
|
+
"status": "ready",
|
|
3040
|
+
"category": "structure",
|
|
3041
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to display content and actions on a single topic inside a container.\n- Use to visually separate specific parts of content in an application view.\n- Use to wrap a form into a container, for example a login form.\n- Include a header when placing a [Table](/components/table) component inside the card.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t place cards within cards. Consider using the [divider](/components/divider/) component to break up sections instead.\n- Don’t use when you need to capture user’s attention in a prominent way.\n- Don’t use to inform user about important changes or conditions in the interface.\n- Don’t use multiple primary buttons inside a card. A card should only contain a single primary action.\n\n</div>\n",
|
|
3042
|
+
"examples": [],
|
|
3043
|
+
"dependencies": [],
|
|
3044
|
+
"tagName": "nord-card",
|
|
3045
|
+
"customElement": true
|
|
3046
|
+
}
|
|
3047
|
+
],
|
|
3048
|
+
"exports": [
|
|
3049
|
+
{
|
|
3050
|
+
"kind": "js",
|
|
3051
|
+
"name": "default",
|
|
3052
|
+
"declaration": {
|
|
3053
|
+
"name": "Card",
|
|
3054
|
+
"module": "src/card/Card.ts"
|
|
3055
|
+
}
|
|
3056
|
+
},
|
|
3057
|
+
{
|
|
3058
|
+
"kind": "custom-element-definition",
|
|
3059
|
+
"name": "nord-card",
|
|
3060
|
+
"declaration": {
|
|
3061
|
+
"name": "Card",
|
|
3062
|
+
"module": "src/card/Card.ts"
|
|
3063
|
+
}
|
|
3064
|
+
}
|
|
3065
|
+
]
|
|
3066
|
+
},
|
|
3067
3067
|
{
|
|
3068
3068
|
"kind": "javascript-module",
|
|
3069
3069
|
"path": "src/command-menu/CommandMenu.ts",
|
|
@@ -11500,15 +11500,25 @@
|
|
|
11500
11500
|
},
|
|
11501
11501
|
{
|
|
11502
11502
|
"kind": "javascript-module",
|
|
11503
|
-
"path": "src/progress/
|
|
11503
|
+
"path": "src/progress-bar/ProgressBar.ts",
|
|
11504
11504
|
"declarations": [
|
|
11505
11505
|
{
|
|
11506
11506
|
"kind": "class",
|
|
11507
|
-
"description": "Progress
|
|
11508
|
-
"name": "
|
|
11507
|
+
"description": "Progress Bar is used to visually represent the completion\nof a task or process. It shows how much of the task has\nbeen completed and how much is still left.",
|
|
11508
|
+
"name": "ProgressBar",
|
|
11509
11509
|
"cssProperties": [
|
|
11510
11510
|
{
|
|
11511
|
-
"description": "Controls the
|
|
11511
|
+
"description": "Controls the thickness of the progress bar, using our [spacing tokens](/tokens/#space).",
|
|
11512
|
+
"name": "--n-progress-size",
|
|
11513
|
+
"default": "var(--n-space-s)"
|
|
11514
|
+
},
|
|
11515
|
+
{
|
|
11516
|
+
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
11517
|
+
"name": "--n-progress-border-radius",
|
|
11518
|
+
"default": "var(--n-border-radius-s)"
|
|
11519
|
+
},
|
|
11520
|
+
{
|
|
11521
|
+
"description": "Controls the color of the progress bar, using [color tokens](/tokens/#color).",
|
|
11512
11522
|
"name": "--n-progress-color",
|
|
11513
11523
|
"default": "var(--n-color-accent)"
|
|
11514
11524
|
}
|
|
@@ -11516,221 +11526,9 @@
|
|
|
11516
11526
|
"members": [
|
|
11517
11527
|
{
|
|
11518
11528
|
"kind": "field",
|
|
11519
|
-
"name": "
|
|
11529
|
+
"name": "value",
|
|
11520
11530
|
"type": {
|
|
11521
|
-
"text": "
|
|
11522
|
-
},
|
|
11523
|
-
"default": "'m'",
|
|
11524
|
-
"description": "The size of the progress indicator.",
|
|
11525
|
-
"attribute": "size",
|
|
11526
|
-
"reflects": true
|
|
11527
|
-
},
|
|
11528
|
-
{
|
|
11529
|
-
"kind": "field",
|
|
11530
|
-
"name": "color",
|
|
11531
|
-
"type": {
|
|
11532
|
-
"text": "string | undefined"
|
|
11533
|
-
},
|
|
11534
|
-
"description": "The color of the progress indicator.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-progress-color` CSS custom property.",
|
|
11535
|
-
"attribute": "color",
|
|
11536
|
-
"reflects": true
|
|
11537
|
-
},
|
|
11538
|
-
{
|
|
11539
|
-
"kind": "field",
|
|
11540
|
-
"name": "label",
|
|
11541
|
-
"type": {
|
|
11542
|
-
"text": "string | undefined"
|
|
11543
|
-
},
|
|
11544
|
-
"description": "An accessible label for the progress indicator.\nIf no label is supplied, the component is hidden from assistive technology.",
|
|
11545
|
-
"attribute": "label",
|
|
11546
|
-
"reflects": true
|
|
11547
|
-
},
|
|
11548
|
-
{
|
|
11549
|
-
"kind": "field",
|
|
11550
|
-
"name": "progress",
|
|
11551
|
-
"type": {
|
|
11552
|
-
"text": "number"
|
|
11553
|
-
},
|
|
11554
|
-
"default": "0",
|
|
11555
|
-
"description": "The progress percentage value.",
|
|
11556
|
-
"attribute": "progress",
|
|
11557
|
-
"reflects": true
|
|
11558
|
-
},
|
|
11559
|
-
{
|
|
11560
|
-
"kind": "field",
|
|
11561
|
-
"name": "_animatedProgress",
|
|
11562
|
-
"type": {
|
|
11563
|
-
"text": "number"
|
|
11564
|
-
},
|
|
11565
|
-
"privacy": "private",
|
|
11566
|
-
"default": "0",
|
|
11567
|
-
"description": "Internal state for the animated progress value."
|
|
11568
|
-
},
|
|
11569
|
-
{
|
|
11570
|
-
"kind": "field",
|
|
11571
|
-
"name": "_animationId",
|
|
11572
|
-
"type": {
|
|
11573
|
-
"text": "number | null"
|
|
11574
|
-
},
|
|
11575
|
-
"privacy": "private",
|
|
11576
|
-
"default": "null",
|
|
11577
|
-
"description": "Animation frame ID for cleanup."
|
|
11578
|
-
},
|
|
11579
|
-
{
|
|
11580
|
-
"kind": "field",
|
|
11581
|
-
"name": "_targetProgress",
|
|
11582
|
-
"type": {
|
|
11583
|
-
"text": "number"
|
|
11584
|
-
},
|
|
11585
|
-
"privacy": "private",
|
|
11586
|
-
"default": "0",
|
|
11587
|
-
"description": "Target progress for animation."
|
|
11588
|
-
},
|
|
11589
|
-
{
|
|
11590
|
-
"kind": "field",
|
|
11591
|
-
"name": "_instanceId",
|
|
11592
|
-
"type": {
|
|
11593
|
-
"text": "number"
|
|
11594
|
-
},
|
|
11595
|
-
"privacy": "private",
|
|
11596
|
-
"default": "instanceCounter++",
|
|
11597
|
-
"description": "Unique ID for this component instance, used for SVG clipPath."
|
|
11598
|
-
},
|
|
11599
|
-
{
|
|
11600
|
-
"kind": "method",
|
|
11601
|
-
"name": "_animate",
|
|
11602
|
-
"privacy": "private"
|
|
11603
|
-
},
|
|
11604
|
-
{
|
|
11605
|
-
"kind": "field",
|
|
11606
|
-
"name": "_clampedProgress",
|
|
11607
|
-
"type": {
|
|
11608
|
-
"text": "number"
|
|
11609
|
-
},
|
|
11610
|
-
"privacy": "private",
|
|
11611
|
-
"readonly": true
|
|
11612
|
-
},
|
|
11613
|
-
{
|
|
11614
|
-
"kind": "field",
|
|
11615
|
-
"name": "_isSemanticColor",
|
|
11616
|
-
"type": {
|
|
11617
|
-
"text": "boolean"
|
|
11618
|
-
},
|
|
11619
|
-
"privacy": "private",
|
|
11620
|
-
"description": "Check if the color is a semantic value handled by CSS.",
|
|
11621
|
-
"readonly": true
|
|
11622
|
-
},
|
|
11623
|
-
{
|
|
11624
|
-
"kind": "field",
|
|
11625
|
-
"name": "_customColorStyle",
|
|
11626
|
-
"type": {
|
|
11627
|
-
"text": "string | undefined"
|
|
11628
|
-
},
|
|
11629
|
-
"privacy": "private",
|
|
11630
|
-
"description": "Get the custom color style if not a semantic value.",
|
|
11631
|
-
"readonly": true
|
|
11632
|
-
}
|
|
11633
|
-
],
|
|
11634
|
-
"attributes": [
|
|
11635
|
-
{
|
|
11636
|
-
"name": "size",
|
|
11637
|
-
"type": {
|
|
11638
|
-
"text": "'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl'"
|
|
11639
|
-
},
|
|
11640
|
-
"default": "'m'",
|
|
11641
|
-
"description": "The size of the progress indicator.",
|
|
11642
|
-
"fieldName": "size"
|
|
11643
|
-
},
|
|
11644
|
-
{
|
|
11645
|
-
"name": "color",
|
|
11646
|
-
"type": {
|
|
11647
|
-
"text": "string | undefined"
|
|
11648
|
-
},
|
|
11649
|
-
"description": "The color of the progress indicator.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-progress-color` CSS custom property.",
|
|
11650
|
-
"fieldName": "color"
|
|
11651
|
-
},
|
|
11652
|
-
{
|
|
11653
|
-
"name": "label",
|
|
11654
|
-
"type": {
|
|
11655
|
-
"text": "string | undefined"
|
|
11656
|
-
},
|
|
11657
|
-
"description": "An accessible label for the progress indicator.\nIf no label is supplied, the component is hidden from assistive technology.",
|
|
11658
|
-
"fieldName": "label"
|
|
11659
|
-
},
|
|
11660
|
-
{
|
|
11661
|
-
"name": "progress",
|
|
11662
|
-
"type": {
|
|
11663
|
-
"text": "number"
|
|
11664
|
-
},
|
|
11665
|
-
"default": "0",
|
|
11666
|
-
"description": "The progress percentage value.",
|
|
11667
|
-
"fieldName": "progress"
|
|
11668
|
-
}
|
|
11669
|
-
],
|
|
11670
|
-
"superclass": {
|
|
11671
|
-
"name": "LitElement",
|
|
11672
|
-
"package": "lit"
|
|
11673
|
-
},
|
|
11674
|
-
"localization": [],
|
|
11675
|
-
"status": "ready",
|
|
11676
|
-
"category": "feedback",
|
|
11677
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to show the completion status of a task with a circular indicator.\n- Use when you can determine the percentage of the completed task at any time.\n- Use the label property to provide an accessible label for the progress indicator.\n- Use for compact spaces where a circular indicator is more appropriate than a linear progress bar.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don't\n\n- Don't use for indeterminate loading states, see [Spinner](/components/spinner/) instead.\n- Don't use when a linear representation of progress is more appropriate, see [Progress Bar](/components/progress-bar/) instead.\n\n</div>\n",
|
|
11678
|
-
"examples": [],
|
|
11679
|
-
"dependencies": [],
|
|
11680
|
-
"tagName": "nord-progress",
|
|
11681
|
-
"customElement": true
|
|
11682
|
-
}
|
|
11683
|
-
],
|
|
11684
|
-
"exports": [
|
|
11685
|
-
{
|
|
11686
|
-
"kind": "js",
|
|
11687
|
-
"name": "default",
|
|
11688
|
-
"declaration": {
|
|
11689
|
-
"name": "Progress",
|
|
11690
|
-
"module": "src/progress/Progress.ts"
|
|
11691
|
-
}
|
|
11692
|
-
},
|
|
11693
|
-
{
|
|
11694
|
-
"kind": "custom-element-definition",
|
|
11695
|
-
"name": "nord-progress",
|
|
11696
|
-
"declaration": {
|
|
11697
|
-
"name": "Progress",
|
|
11698
|
-
"module": "src/progress/Progress.ts"
|
|
11699
|
-
}
|
|
11700
|
-
}
|
|
11701
|
-
]
|
|
11702
|
-
},
|
|
11703
|
-
{
|
|
11704
|
-
"kind": "javascript-module",
|
|
11705
|
-
"path": "src/progress-bar/ProgressBar.ts",
|
|
11706
|
-
"declarations": [
|
|
11707
|
-
{
|
|
11708
|
-
"kind": "class",
|
|
11709
|
-
"description": "Progress Bar is used to visually represent the completion\nof a task or process. It shows how much of the task has\nbeen completed and how much is still left.",
|
|
11710
|
-
"name": "ProgressBar",
|
|
11711
|
-
"cssProperties": [
|
|
11712
|
-
{
|
|
11713
|
-
"description": "Controls the thickness of the progress bar, using our [spacing tokens](/tokens/#space).",
|
|
11714
|
-
"name": "--n-progress-size",
|
|
11715
|
-
"default": "var(--n-space-s)"
|
|
11716
|
-
},
|
|
11717
|
-
{
|
|
11718
|
-
"description": "Controls how rounded the corners are, using [border radius tokens](/tokens/#border-radius).",
|
|
11719
|
-
"name": "--n-progress-border-radius",
|
|
11720
|
-
"default": "var(--n-border-radius-s)"
|
|
11721
|
-
},
|
|
11722
|
-
{
|
|
11723
|
-
"description": "Controls the color of the progress bar, using [color tokens](/tokens/#color).",
|
|
11724
|
-
"name": "--n-progress-color",
|
|
11725
|
-
"default": "var(--n-color-accent)"
|
|
11726
|
-
}
|
|
11727
|
-
],
|
|
11728
|
-
"members": [
|
|
11729
|
-
{
|
|
11730
|
-
"kind": "field",
|
|
11731
|
-
"name": "value",
|
|
11732
|
-
"type": {
|
|
11733
|
-
"text": "number | undefined"
|
|
11531
|
+
"text": "number | undefined"
|
|
11734
11532
|
},
|
|
11735
11533
|
"description": "Specifies how much of the task has been completed. Must be a valid floating\npoint number between 0 and max, or between 0 and 100 if max is omitted. If\nthere is no value, the progress bar is indeterminate; this indicates that\nan activity is ongoing with no indication of how long it’s expected to take.",
|
|
11736
11534
|
"attribute": "value",
|
|
@@ -15068,16 +14866,16 @@
|
|
|
15068
14866
|
},
|
|
15069
14867
|
{
|
|
15070
14868
|
"kind": "javascript-module",
|
|
15071
|
-
"path": "src/
|
|
14869
|
+
"path": "src/progress/Progress.ts",
|
|
15072
14870
|
"declarations": [
|
|
15073
14871
|
{
|
|
15074
14872
|
"kind": "class",
|
|
15075
|
-
"description": "
|
|
15076
|
-
"name": "
|
|
14873
|
+
"description": "Progress component is used to display a circular pie-chart style progress indicator.\nYou can customize the size and color of the progress indicator with the\nprovided properties.",
|
|
14874
|
+
"name": "Progress",
|
|
15077
14875
|
"cssProperties": [
|
|
15078
14876
|
{
|
|
15079
|
-
"description": "Controls the color the
|
|
15080
|
-
"name": "--n-
|
|
14877
|
+
"description": "Controls the color of the progress indicator.",
|
|
14878
|
+
"name": "--n-progress-color",
|
|
15081
14879
|
"default": "var(--n-color-accent)"
|
|
15082
14880
|
}
|
|
15083
14881
|
],
|
|
@@ -15089,7 +14887,7 @@
|
|
|
15089
14887
|
"text": "'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl'"
|
|
15090
14888
|
},
|
|
15091
14889
|
"default": "'m'",
|
|
15092
|
-
"description": "The size of the
|
|
14890
|
+
"description": "The size of the progress indicator.",
|
|
15093
14891
|
"attribute": "size",
|
|
15094
14892
|
"reflects": true
|
|
15095
14893
|
},
|
|
@@ -15099,7 +14897,7 @@
|
|
|
15099
14897
|
"type": {
|
|
15100
14898
|
"text": "string | undefined"
|
|
15101
14899
|
},
|
|
15102
|
-
"description": "The color of the
|
|
14900
|
+
"description": "The color of the progress indicator.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-progress-color` CSS custom property.",
|
|
15103
14901
|
"attribute": "color",
|
|
15104
14902
|
"reflects": true
|
|
15105
14903
|
},
|
|
@@ -15109,32 +14907,234 @@
|
|
|
15109
14907
|
"type": {
|
|
15110
14908
|
"text": "string | undefined"
|
|
15111
14909
|
},
|
|
15112
|
-
"description": "An accessible label for the
|
|
14910
|
+
"description": "An accessible label for the progress indicator.\nIf no label is supplied, the component is hidden from assistive technology.",
|
|
15113
14911
|
"attribute": "label",
|
|
15114
14912
|
"reflects": true
|
|
15115
|
-
}
|
|
15116
|
-
],
|
|
15117
|
-
"attributes": [
|
|
14913
|
+
},
|
|
15118
14914
|
{
|
|
15119
|
-
"
|
|
14915
|
+
"kind": "field",
|
|
14916
|
+
"name": "progress",
|
|
15120
14917
|
"type": {
|
|
15121
|
-
"text": "
|
|
14918
|
+
"text": "number"
|
|
15122
14919
|
},
|
|
15123
|
-
"default": "
|
|
15124
|
-
"description": "The
|
|
15125
|
-
"
|
|
14920
|
+
"default": "0",
|
|
14921
|
+
"description": "The progress percentage value.",
|
|
14922
|
+
"attribute": "progress",
|
|
14923
|
+
"reflects": true
|
|
15126
14924
|
},
|
|
15127
14925
|
{
|
|
15128
|
-
"
|
|
14926
|
+
"kind": "field",
|
|
14927
|
+
"name": "_animatedProgress",
|
|
15129
14928
|
"type": {
|
|
15130
|
-
"text": "
|
|
14929
|
+
"text": "number"
|
|
15131
14930
|
},
|
|
15132
|
-
"
|
|
15133
|
-
"
|
|
14931
|
+
"privacy": "private",
|
|
14932
|
+
"default": "0",
|
|
14933
|
+
"description": "Internal state for the animated progress value."
|
|
15134
14934
|
},
|
|
15135
14935
|
{
|
|
15136
|
-
"
|
|
15137
|
-
"
|
|
14936
|
+
"kind": "field",
|
|
14937
|
+
"name": "_animationId",
|
|
14938
|
+
"type": {
|
|
14939
|
+
"text": "number | null"
|
|
14940
|
+
},
|
|
14941
|
+
"privacy": "private",
|
|
14942
|
+
"default": "null",
|
|
14943
|
+
"description": "Animation frame ID for cleanup."
|
|
14944
|
+
},
|
|
14945
|
+
{
|
|
14946
|
+
"kind": "field",
|
|
14947
|
+
"name": "_targetProgress",
|
|
14948
|
+
"type": {
|
|
14949
|
+
"text": "number"
|
|
14950
|
+
},
|
|
14951
|
+
"privacy": "private",
|
|
14952
|
+
"default": "0",
|
|
14953
|
+
"description": "Target progress for animation."
|
|
14954
|
+
},
|
|
14955
|
+
{
|
|
14956
|
+
"kind": "field",
|
|
14957
|
+
"name": "_instanceId",
|
|
14958
|
+
"type": {
|
|
14959
|
+
"text": "number"
|
|
14960
|
+
},
|
|
14961
|
+
"privacy": "private",
|
|
14962
|
+
"default": "instanceCounter++",
|
|
14963
|
+
"description": "Unique ID for this component instance, used for SVG clipPath."
|
|
14964
|
+
},
|
|
14965
|
+
{
|
|
14966
|
+
"kind": "method",
|
|
14967
|
+
"name": "_animate",
|
|
14968
|
+
"privacy": "private"
|
|
14969
|
+
},
|
|
14970
|
+
{
|
|
14971
|
+
"kind": "field",
|
|
14972
|
+
"name": "_clampedProgress",
|
|
14973
|
+
"type": {
|
|
14974
|
+
"text": "number"
|
|
14975
|
+
},
|
|
14976
|
+
"privacy": "private",
|
|
14977
|
+
"readonly": true
|
|
14978
|
+
},
|
|
14979
|
+
{
|
|
14980
|
+
"kind": "field",
|
|
14981
|
+
"name": "_isSemanticColor",
|
|
14982
|
+
"type": {
|
|
14983
|
+
"text": "boolean"
|
|
14984
|
+
},
|
|
14985
|
+
"privacy": "private",
|
|
14986
|
+
"description": "Check if the color is a semantic value handled by CSS.",
|
|
14987
|
+
"readonly": true
|
|
14988
|
+
},
|
|
14989
|
+
{
|
|
14990
|
+
"kind": "field",
|
|
14991
|
+
"name": "_customColorStyle",
|
|
14992
|
+
"type": {
|
|
14993
|
+
"text": "string | undefined"
|
|
14994
|
+
},
|
|
14995
|
+
"privacy": "private",
|
|
14996
|
+
"description": "Get the custom color style if not a semantic value.",
|
|
14997
|
+
"readonly": true
|
|
14998
|
+
}
|
|
14999
|
+
],
|
|
15000
|
+
"attributes": [
|
|
15001
|
+
{
|
|
15002
|
+
"name": "size",
|
|
15003
|
+
"type": {
|
|
15004
|
+
"text": "'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl'"
|
|
15005
|
+
},
|
|
15006
|
+
"default": "'m'",
|
|
15007
|
+
"description": "The size of the progress indicator.",
|
|
15008
|
+
"fieldName": "size"
|
|
15009
|
+
},
|
|
15010
|
+
{
|
|
15011
|
+
"name": "color",
|
|
15012
|
+
"type": {
|
|
15013
|
+
"text": "string | undefined"
|
|
15014
|
+
},
|
|
15015
|
+
"description": "The color of the progress indicator.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-progress-color` CSS custom property.",
|
|
15016
|
+
"fieldName": "color"
|
|
15017
|
+
},
|
|
15018
|
+
{
|
|
15019
|
+
"name": "label",
|
|
15020
|
+
"type": {
|
|
15021
|
+
"text": "string | undefined"
|
|
15022
|
+
},
|
|
15023
|
+
"description": "An accessible label for the progress indicator.\nIf no label is supplied, the component is hidden from assistive technology.",
|
|
15024
|
+
"fieldName": "label"
|
|
15025
|
+
},
|
|
15026
|
+
{
|
|
15027
|
+
"name": "progress",
|
|
15028
|
+
"type": {
|
|
15029
|
+
"text": "number"
|
|
15030
|
+
},
|
|
15031
|
+
"default": "0",
|
|
15032
|
+
"description": "The progress percentage value.",
|
|
15033
|
+
"fieldName": "progress"
|
|
15034
|
+
}
|
|
15035
|
+
],
|
|
15036
|
+
"superclass": {
|
|
15037
|
+
"name": "LitElement",
|
|
15038
|
+
"package": "lit"
|
|
15039
|
+
},
|
|
15040
|
+
"localization": [],
|
|
15041
|
+
"status": "ready",
|
|
15042
|
+
"category": "feedback",
|
|
15043
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use to show the completion status of a task with a circular indicator.\n- Use when you can determine the percentage of the completed task at any time.\n- Use the label property to provide an accessible label for the progress indicator.\n- Use for compact spaces where a circular indicator is more appropriate than a linear progress bar.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don't\n\n- Don't use for indeterminate loading states, see [Spinner](/components/spinner/) instead.\n- Don't use when a linear representation of progress is more appropriate, see [Progress Bar](/components/progress-bar/) instead.\n\n</div>\n",
|
|
15044
|
+
"examples": [],
|
|
15045
|
+
"dependencies": [],
|
|
15046
|
+
"tagName": "nord-progress",
|
|
15047
|
+
"customElement": true
|
|
15048
|
+
}
|
|
15049
|
+
],
|
|
15050
|
+
"exports": [
|
|
15051
|
+
{
|
|
15052
|
+
"kind": "js",
|
|
15053
|
+
"name": "default",
|
|
15054
|
+
"declaration": {
|
|
15055
|
+
"name": "Progress",
|
|
15056
|
+
"module": "src/progress/Progress.ts"
|
|
15057
|
+
}
|
|
15058
|
+
},
|
|
15059
|
+
{
|
|
15060
|
+
"kind": "custom-element-definition",
|
|
15061
|
+
"name": "nord-progress",
|
|
15062
|
+
"declaration": {
|
|
15063
|
+
"name": "Progress",
|
|
15064
|
+
"module": "src/progress/Progress.ts"
|
|
15065
|
+
}
|
|
15066
|
+
}
|
|
15067
|
+
]
|
|
15068
|
+
},
|
|
15069
|
+
{
|
|
15070
|
+
"kind": "javascript-module",
|
|
15071
|
+
"path": "src/spinner/Spinner.ts",
|
|
15072
|
+
"declarations": [
|
|
15073
|
+
{
|
|
15074
|
+
"kind": "class",
|
|
15075
|
+
"description": "Spinner component is used to indicate users that their action is being\nprocessed. You can customize the size and color of the spinner with the\nprovided properties.",
|
|
15076
|
+
"name": "Spinner",
|
|
15077
|
+
"cssProperties": [
|
|
15078
|
+
{
|
|
15079
|
+
"description": "Controls the color the spinner.",
|
|
15080
|
+
"name": "--n-spinner-color",
|
|
15081
|
+
"default": "var(--n-color-accent)"
|
|
15082
|
+
}
|
|
15083
|
+
],
|
|
15084
|
+
"members": [
|
|
15085
|
+
{
|
|
15086
|
+
"kind": "field",
|
|
15087
|
+
"name": "size",
|
|
15088
|
+
"type": {
|
|
15089
|
+
"text": "'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl'"
|
|
15090
|
+
},
|
|
15091
|
+
"default": "'m'",
|
|
15092
|
+
"description": "The size of the spinner.",
|
|
15093
|
+
"attribute": "size",
|
|
15094
|
+
"reflects": true
|
|
15095
|
+
},
|
|
15096
|
+
{
|
|
15097
|
+
"kind": "field",
|
|
15098
|
+
"name": "color",
|
|
15099
|
+
"type": {
|
|
15100
|
+
"text": "string | undefined"
|
|
15101
|
+
},
|
|
15102
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-spinner-color` CSS custom property.",
|
|
15103
|
+
"attribute": "color",
|
|
15104
|
+
"reflects": true
|
|
15105
|
+
},
|
|
15106
|
+
{
|
|
15107
|
+
"kind": "field",
|
|
15108
|
+
"name": "label",
|
|
15109
|
+
"type": {
|
|
15110
|
+
"text": "string | undefined"
|
|
15111
|
+
},
|
|
15112
|
+
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
15113
|
+
"attribute": "label",
|
|
15114
|
+
"reflects": true
|
|
15115
|
+
}
|
|
15116
|
+
],
|
|
15117
|
+
"attributes": [
|
|
15118
|
+
{
|
|
15119
|
+
"name": "size",
|
|
15120
|
+
"type": {
|
|
15121
|
+
"text": "'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl'"
|
|
15122
|
+
},
|
|
15123
|
+
"default": "'m'",
|
|
15124
|
+
"description": "The size of the spinner.",
|
|
15125
|
+
"fieldName": "size"
|
|
15126
|
+
},
|
|
15127
|
+
{
|
|
15128
|
+
"name": "color",
|
|
15129
|
+
"type": {
|
|
15130
|
+
"text": "string | undefined"
|
|
15131
|
+
},
|
|
15132
|
+
"description": "The color of the spinner.\nCan accept any valid CSS color value, including custom properties.\nTakes precedence over the `--n-spinner-color` CSS custom property.",
|
|
15133
|
+
"fieldName": "color"
|
|
15134
|
+
},
|
|
15135
|
+
{
|
|
15136
|
+
"name": "label",
|
|
15137
|
+
"type": {
|
|
15138
15138
|
"text": "string | undefined"
|
|
15139
15139
|
},
|
|
15140
15140
|
"description": "An accessible label for the spinner.\nIf no label is supplied, the spinner is hidden from assistive technology.",
|
|
@@ -15332,55 +15332,150 @@
|
|
|
15332
15332
|
},
|
|
15333
15333
|
{
|
|
15334
15334
|
"kind": "javascript-module",
|
|
15335
|
-
"path": "src/tab
|
|
15335
|
+
"path": "src/tab/Tab.ts",
|
|
15336
15336
|
"declarations": [
|
|
15337
15337
|
{
|
|
15338
15338
|
"kind": "class",
|
|
15339
|
-
"description": "
|
|
15340
|
-
"name": "
|
|
15339
|
+
"description": "The interactive tab button for use within the tab group component.",
|
|
15340
|
+
"name": "Tab",
|
|
15341
15341
|
"cssProperties": [
|
|
15342
15342
|
{
|
|
15343
|
-
"description": "Controls the
|
|
15344
|
-
"name": "--n-tab-
|
|
15345
|
-
"default": "
|
|
15343
|
+
"description": "Controls the text color of the tab, using our [color tokens](/tokens/#color).",
|
|
15344
|
+
"name": "--n-tab-color",
|
|
15345
|
+
"default": "var(--n-color-text-weak)"
|
|
15346
|
+
},
|
|
15347
|
+
{
|
|
15348
|
+
"description": "Controls the font weight of the tab, using our [font tokens](/tokens/#font).",
|
|
15349
|
+
"name": "--n-tab-font-weight",
|
|
15350
|
+
"default": "var(--n-font-weight)"
|
|
15346
15351
|
}
|
|
15347
15352
|
],
|
|
15348
15353
|
"slots": [
|
|
15349
15354
|
{
|
|
15350
|
-
"description": "The
|
|
15355
|
+
"description": "The tab button content.",
|
|
15351
15356
|
"name": ""
|
|
15352
|
-
},
|
|
15353
|
-
{
|
|
15354
|
-
"description": "The element which contains all tabs to reveal tabbed content.",
|
|
15355
|
-
"name": "tab"
|
|
15356
15357
|
}
|
|
15357
15358
|
],
|
|
15358
15359
|
"members": [
|
|
15359
15360
|
{
|
|
15360
15361
|
"kind": "field",
|
|
15361
|
-
"name": "
|
|
15362
|
+
"name": "defaultSlot",
|
|
15362
15363
|
"privacy": "private",
|
|
15363
|
-
"default": "new
|
|
15364
|
+
"default": "new SlotController(this)"
|
|
15364
15365
|
},
|
|
15365
15366
|
{
|
|
15366
15367
|
"kind": "field",
|
|
15367
|
-
"name": "
|
|
15368
|
+
"name": "selected",
|
|
15368
15369
|
"type": {
|
|
15369
|
-
"text": "
|
|
15370
|
+
"text": "boolean"
|
|
15370
15371
|
},
|
|
15371
|
-
"
|
|
15372
|
+
"default": "false",
|
|
15373
|
+
"description": "Whether the tab item is selected",
|
|
15374
|
+
"attribute": "selected",
|
|
15375
|
+
"reflects": true
|
|
15372
15376
|
},
|
|
15373
15377
|
{
|
|
15374
|
-
"kind": "
|
|
15375
|
-
"name": "
|
|
15378
|
+
"kind": "method",
|
|
15379
|
+
"name": "handleSelectionChange",
|
|
15380
|
+
"privacy": "protected",
|
|
15381
|
+
"description": "Apply accessible attributes and values to the tab button.\nObserve the selected property if it changes"
|
|
15382
|
+
}
|
|
15383
|
+
],
|
|
15384
|
+
"attributes": [
|
|
15385
|
+
{
|
|
15386
|
+
"name": "selected",
|
|
15376
15387
|
"type": {
|
|
15377
|
-
"text": "
|
|
15388
|
+
"text": "boolean"
|
|
15378
15389
|
},
|
|
15379
|
-
"
|
|
15380
|
-
"
|
|
15381
|
-
"
|
|
15382
|
-
}
|
|
15383
|
-
|
|
15390
|
+
"default": "false",
|
|
15391
|
+
"description": "Whether the tab item is selected",
|
|
15392
|
+
"fieldName": "selected"
|
|
15393
|
+
}
|
|
15394
|
+
],
|
|
15395
|
+
"superclass": {
|
|
15396
|
+
"name": "LitElement",
|
|
15397
|
+
"package": "lit"
|
|
15398
|
+
},
|
|
15399
|
+
"localization": [],
|
|
15400
|
+
"status": "ready",
|
|
15401
|
+
"category": "navigation",
|
|
15402
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab component within the tab group component.\n- Use the `selected` option to signify if the tab is selected.\n- Use text, icons and other non-interactive content within the tab.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use the tab component outside of the tab group component.\n- Don't add interactive elements, such as buttons and links, inside the tab component.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular section you wish to show out of order of the tabs UI itself consider using the `selected` option to select the tab but prevent the order of the tabs being affected.\n",
|
|
15403
|
+
"examples": [],
|
|
15404
|
+
"dependencies": [],
|
|
15405
|
+
"tagName": "nord-tab",
|
|
15406
|
+
"customElement": true
|
|
15407
|
+
}
|
|
15408
|
+
],
|
|
15409
|
+
"exports": [
|
|
15410
|
+
{
|
|
15411
|
+
"kind": "js",
|
|
15412
|
+
"name": "default",
|
|
15413
|
+
"declaration": {
|
|
15414
|
+
"name": "Tab",
|
|
15415
|
+
"module": "src/tab/Tab.ts"
|
|
15416
|
+
}
|
|
15417
|
+
},
|
|
15418
|
+
{
|
|
15419
|
+
"kind": "custom-element-definition",
|
|
15420
|
+
"name": "nord-tab",
|
|
15421
|
+
"declaration": {
|
|
15422
|
+
"name": "Tab",
|
|
15423
|
+
"module": "src/tab/Tab.ts"
|
|
15424
|
+
}
|
|
15425
|
+
}
|
|
15426
|
+
]
|
|
15427
|
+
},
|
|
15428
|
+
{
|
|
15429
|
+
"kind": "javascript-module",
|
|
15430
|
+
"path": "src/tab-group/TabGroup.ts",
|
|
15431
|
+
"declarations": [
|
|
15432
|
+
{
|
|
15433
|
+
"kind": "class",
|
|
15434
|
+
"description": "Tab Group allows multiple panels to be contained within a single window,\nusing tabs as a navigational element.",
|
|
15435
|
+
"name": "TabGroup",
|
|
15436
|
+
"cssProperties": [
|
|
15437
|
+
{
|
|
15438
|
+
"description": "Controls the padding around the tab group (including the tab list), using our [spacing tokens](/tokens/#space).",
|
|
15439
|
+
"name": "--n-tab-group-padding",
|
|
15440
|
+
"default": "0"
|
|
15441
|
+
}
|
|
15442
|
+
],
|
|
15443
|
+
"slots": [
|
|
15444
|
+
{
|
|
15445
|
+
"description": "The element which contains the content to be revealed.",
|
|
15446
|
+
"name": ""
|
|
15447
|
+
},
|
|
15448
|
+
{
|
|
15449
|
+
"description": "The element which contains all tabs to reveal tabbed content.",
|
|
15450
|
+
"name": "tab"
|
|
15451
|
+
}
|
|
15452
|
+
],
|
|
15453
|
+
"members": [
|
|
15454
|
+
{
|
|
15455
|
+
"kind": "field",
|
|
15456
|
+
"name": "direction",
|
|
15457
|
+
"privacy": "private",
|
|
15458
|
+
"default": "new DirectionController(this)"
|
|
15459
|
+
},
|
|
15460
|
+
{
|
|
15461
|
+
"kind": "field",
|
|
15462
|
+
"name": "observer",
|
|
15463
|
+
"type": {
|
|
15464
|
+
"text": "MutationObserver | undefined"
|
|
15465
|
+
},
|
|
15466
|
+
"privacy": "private"
|
|
15467
|
+
},
|
|
15468
|
+
{
|
|
15469
|
+
"kind": "field",
|
|
15470
|
+
"name": "observerOptions",
|
|
15471
|
+
"type": {
|
|
15472
|
+
"text": "object"
|
|
15473
|
+
},
|
|
15474
|
+
"privacy": "private",
|
|
15475
|
+
"static": true,
|
|
15476
|
+
"default": "{ attributes: true, subtree: true, attributeFilter: ['selected'], attributeOldValue: true, }"
|
|
15477
|
+
},
|
|
15478
|
+
{
|
|
15384
15479
|
"kind": "field",
|
|
15385
15480
|
"name": "tabGroupId",
|
|
15386
15481
|
"privacy": "private",
|
|
@@ -15581,149 +15676,6 @@
|
|
|
15581
15676
|
}
|
|
15582
15677
|
]
|
|
15583
15678
|
},
|
|
15584
|
-
{
|
|
15585
|
-
"kind": "javascript-module",
|
|
15586
|
-
"path": "src/tab/Tab.ts",
|
|
15587
|
-
"declarations": [
|
|
15588
|
-
{
|
|
15589
|
-
"kind": "class",
|
|
15590
|
-
"description": "The interactive tab button for use within the tab group component.",
|
|
15591
|
-
"name": "Tab",
|
|
15592
|
-
"cssProperties": [
|
|
15593
|
-
{
|
|
15594
|
-
"description": "Controls the text color of the tab, using our [color tokens](/tokens/#color).",
|
|
15595
|
-
"name": "--n-tab-color",
|
|
15596
|
-
"default": "var(--n-color-text-weak)"
|
|
15597
|
-
},
|
|
15598
|
-
{
|
|
15599
|
-
"description": "Controls the font weight of the tab, using our [font tokens](/tokens/#font).",
|
|
15600
|
-
"name": "--n-tab-font-weight",
|
|
15601
|
-
"default": "var(--n-font-weight)"
|
|
15602
|
-
}
|
|
15603
|
-
],
|
|
15604
|
-
"slots": [
|
|
15605
|
-
{
|
|
15606
|
-
"description": "The tab button content.",
|
|
15607
|
-
"name": ""
|
|
15608
|
-
}
|
|
15609
|
-
],
|
|
15610
|
-
"members": [
|
|
15611
|
-
{
|
|
15612
|
-
"kind": "field",
|
|
15613
|
-
"name": "defaultSlot",
|
|
15614
|
-
"privacy": "private",
|
|
15615
|
-
"default": "new SlotController(this)"
|
|
15616
|
-
},
|
|
15617
|
-
{
|
|
15618
|
-
"kind": "field",
|
|
15619
|
-
"name": "selected",
|
|
15620
|
-
"type": {
|
|
15621
|
-
"text": "boolean"
|
|
15622
|
-
},
|
|
15623
|
-
"default": "false",
|
|
15624
|
-
"description": "Whether the tab item is selected",
|
|
15625
|
-
"attribute": "selected",
|
|
15626
|
-
"reflects": true
|
|
15627
|
-
},
|
|
15628
|
-
{
|
|
15629
|
-
"kind": "method",
|
|
15630
|
-
"name": "handleSelectionChange",
|
|
15631
|
-
"privacy": "protected",
|
|
15632
|
-
"description": "Apply accessible attributes and values to the tab button.\nObserve the selected property if it changes"
|
|
15633
|
-
}
|
|
15634
|
-
],
|
|
15635
|
-
"attributes": [
|
|
15636
|
-
{
|
|
15637
|
-
"name": "selected",
|
|
15638
|
-
"type": {
|
|
15639
|
-
"text": "boolean"
|
|
15640
|
-
},
|
|
15641
|
-
"default": "false",
|
|
15642
|
-
"description": "Whether the tab item is selected",
|
|
15643
|
-
"fieldName": "selected"
|
|
15644
|
-
}
|
|
15645
|
-
],
|
|
15646
|
-
"superclass": {
|
|
15647
|
-
"name": "LitElement",
|
|
15648
|
-
"package": "lit"
|
|
15649
|
-
},
|
|
15650
|
-
"localization": [],
|
|
15651
|
-
"status": "ready",
|
|
15652
|
-
"category": "navigation",
|
|
15653
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab component within the tab group component.\n- Use the `selected` option to signify if the tab is selected.\n- Use text, icons and other non-interactive content within the tab.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use tabs to navigate to other pages. Use navigation or links instead.\n- Don't use the tab component outside of the tab group component.\n- Don't add interactive elements, such as buttons and links, inside the tab component.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular section you wish to show out of order of the tabs UI itself consider using the `selected` option to select the tab but prevent the order of the tabs being affected.\n",
|
|
15654
|
-
"examples": [],
|
|
15655
|
-
"dependencies": [],
|
|
15656
|
-
"tagName": "nord-tab",
|
|
15657
|
-
"customElement": true
|
|
15658
|
-
}
|
|
15659
|
-
],
|
|
15660
|
-
"exports": [
|
|
15661
|
-
{
|
|
15662
|
-
"kind": "js",
|
|
15663
|
-
"name": "default",
|
|
15664
|
-
"declaration": {
|
|
15665
|
-
"name": "Tab",
|
|
15666
|
-
"module": "src/tab/Tab.ts"
|
|
15667
|
-
}
|
|
15668
|
-
},
|
|
15669
|
-
{
|
|
15670
|
-
"kind": "custom-element-definition",
|
|
15671
|
-
"name": "nord-tab",
|
|
15672
|
-
"declaration": {
|
|
15673
|
-
"name": "Tab",
|
|
15674
|
-
"module": "src/tab/Tab.ts"
|
|
15675
|
-
}
|
|
15676
|
-
}
|
|
15677
|
-
]
|
|
15678
|
-
},
|
|
15679
|
-
{
|
|
15680
|
-
"kind": "javascript-module",
|
|
15681
|
-
"path": "src/tab-panel/TabPanel.ts",
|
|
15682
|
-
"declarations": [
|
|
15683
|
-
{
|
|
15684
|
-
"kind": "class",
|
|
15685
|
-
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
15686
|
-
"name": "TabPanel",
|
|
15687
|
-
"slots": [
|
|
15688
|
-
{
|
|
15689
|
-
"description": "The tab panel content.",
|
|
15690
|
-
"name": ""
|
|
15691
|
-
}
|
|
15692
|
-
],
|
|
15693
|
-
"members": [],
|
|
15694
|
-
"superclass": {
|
|
15695
|
-
"name": "LitElement",
|
|
15696
|
-
"package": "lit"
|
|
15697
|
-
},
|
|
15698
|
-
"localization": [],
|
|
15699
|
-
"status": "ready",
|
|
15700
|
-
"category": "navigation",
|
|
15701
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab panel component within the tab group component.\n- Use both non-interactive and interactive elements within the contents of the tab panel.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don't use the tab panel component outside of the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the related tab component to select the tab but prevent the order of the tabs being affected.\n",
|
|
15702
|
-
"examples": [],
|
|
15703
|
-
"dependencies": [],
|
|
15704
|
-
"tagName": "nord-tab-panel",
|
|
15705
|
-
"customElement": true
|
|
15706
|
-
}
|
|
15707
|
-
],
|
|
15708
|
-
"exports": [
|
|
15709
|
-
{
|
|
15710
|
-
"kind": "js",
|
|
15711
|
-
"name": "default",
|
|
15712
|
-
"declaration": {
|
|
15713
|
-
"name": "TabPanel",
|
|
15714
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
15715
|
-
}
|
|
15716
|
-
},
|
|
15717
|
-
{
|
|
15718
|
-
"kind": "custom-element-definition",
|
|
15719
|
-
"name": "nord-tab-panel",
|
|
15720
|
-
"declaration": {
|
|
15721
|
-
"name": "TabPanel",
|
|
15722
|
-
"module": "src/tab-panel/TabPanel.ts"
|
|
15723
|
-
}
|
|
15724
|
-
}
|
|
15725
|
-
]
|
|
15726
|
-
},
|
|
15727
15679
|
{
|
|
15728
15680
|
"kind": "javascript-module",
|
|
15729
15681
|
"path": "src/table/Table.ts",
|
|
@@ -15872,34 +15824,82 @@
|
|
|
15872
15824
|
},
|
|
15873
15825
|
{
|
|
15874
15826
|
"kind": "javascript-module",
|
|
15875
|
-
"path": "src/
|
|
15827
|
+
"path": "src/tab-panel/TabPanel.ts",
|
|
15876
15828
|
"declarations": [
|
|
15877
15829
|
{
|
|
15878
15830
|
"kind": "class",
|
|
15879
|
-
"description": "
|
|
15880
|
-
"name": "
|
|
15831
|
+
"description": "The panel which contains content that can be revealed using a tab\nin the tab group component.",
|
|
15832
|
+
"name": "TabPanel",
|
|
15881
15833
|
"slots": [
|
|
15882
15834
|
{
|
|
15883
|
-
"description": "The
|
|
15835
|
+
"description": "The tab panel content.",
|
|
15884
15836
|
"name": ""
|
|
15885
15837
|
}
|
|
15886
15838
|
],
|
|
15887
|
-
"members": [
|
|
15888
|
-
|
|
15889
|
-
|
|
15890
|
-
|
|
15891
|
-
|
|
15892
|
-
|
|
15893
|
-
|
|
15894
|
-
|
|
15895
|
-
|
|
15896
|
-
|
|
15897
|
-
|
|
15898
|
-
|
|
15899
|
-
|
|
15900
|
-
|
|
15901
|
-
|
|
15902
|
-
|
|
15839
|
+
"members": [],
|
|
15840
|
+
"superclass": {
|
|
15841
|
+
"name": "LitElement",
|
|
15842
|
+
"package": "lit"
|
|
15843
|
+
},
|
|
15844
|
+
"localization": [],
|
|
15845
|
+
"status": "ready",
|
|
15846
|
+
"category": "navigation",
|
|
15847
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use the tab panel component within the tab group component.\n- Use both non-interactive and interactive elements within the contents of the tab panel.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don't use the tab panel component outside of the tab group component.\n- Don't obscure important information within a tab panel that isn't revealed by default.\n\n</div>\n\n---\n\n## Content guidelines\n\nWhen writing tab labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">My tasks</div>\n<div class=\"n-usage n-usage-dont\">My Tasks</div>\n\nAvoid unnecessary words and articles in tab labels, such as “the”, “an” or “a”:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">The dashboard</div>\n\nAvoid ending tab labels in punctuation:\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients.</div>\n\nUse as few words as possible to describe each tab label:\n\n<div class=\"n-usage n-usage-do\">Payments</div>\n<div class=\"n-usage n-usage-dont\">Payments in your clinic</div>\n\nAvoid all caps for tab labels:\n\n<div class=\"n-usage n-usage-do\">Dashboard</div>\n<div class=\"n-usage n-usage-dont\">DASHBOARD</div>\n\n---\n\n## Additional considerations\n\n- If the content contained within the tabs UI has significance or is important for the user to see, consider using a different form of presentation that doesn't obscure it.\n- If there is a particular tab panel you wish to show out of order of the tabs UI itself consider using the `selected` option on the related tab component to select the tab but prevent the order of the tabs being affected.\n",
|
|
15848
|
+
"examples": [],
|
|
15849
|
+
"dependencies": [],
|
|
15850
|
+
"tagName": "nord-tab-panel",
|
|
15851
|
+
"customElement": true
|
|
15852
|
+
}
|
|
15853
|
+
],
|
|
15854
|
+
"exports": [
|
|
15855
|
+
{
|
|
15856
|
+
"kind": "js",
|
|
15857
|
+
"name": "default",
|
|
15858
|
+
"declaration": {
|
|
15859
|
+
"name": "TabPanel",
|
|
15860
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15861
|
+
}
|
|
15862
|
+
},
|
|
15863
|
+
{
|
|
15864
|
+
"kind": "custom-element-definition",
|
|
15865
|
+
"name": "nord-tab-panel",
|
|
15866
|
+
"declaration": {
|
|
15867
|
+
"name": "TabPanel",
|
|
15868
|
+
"module": "src/tab-panel/TabPanel.ts"
|
|
15869
|
+
}
|
|
15870
|
+
}
|
|
15871
|
+
]
|
|
15872
|
+
},
|
|
15873
|
+
{
|
|
15874
|
+
"kind": "javascript-module",
|
|
15875
|
+
"path": "src/tag/Tag.ts",
|
|
15876
|
+
"declarations": [
|
|
15877
|
+
{
|
|
15878
|
+
"kind": "class",
|
|
15879
|
+
"description": "Tags represent a set of keywords that help label, categorize,\nand organize objects. Commonly used to signify the attributes of an object.",
|
|
15880
|
+
"name": "Tag",
|
|
15881
|
+
"slots": [
|
|
15882
|
+
{
|
|
15883
|
+
"description": "The tag content.",
|
|
15884
|
+
"name": ""
|
|
15885
|
+
}
|
|
15886
|
+
],
|
|
15887
|
+
"members": [
|
|
15888
|
+
{
|
|
15889
|
+
"kind": "field",
|
|
15890
|
+
"name": "localize",
|
|
15891
|
+
"privacy": "private",
|
|
15892
|
+
"default": "new LocalizeController<'nord-tag'>(this)"
|
|
15893
|
+
},
|
|
15894
|
+
{
|
|
15895
|
+
"kind": "field",
|
|
15896
|
+
"name": "formData",
|
|
15897
|
+
"privacy": "protected",
|
|
15898
|
+
"default": "new FormDataController(this, { value: () => this.formValue })"
|
|
15899
|
+
},
|
|
15900
|
+
{
|
|
15901
|
+
"kind": "field",
|
|
15902
|
+
"name": "formValue",
|
|
15903
15903
|
"privacy": "protected",
|
|
15904
15904
|
"readonly": true
|
|
15905
15905
|
},
|
|
@@ -17782,245 +17782,305 @@
|
|
|
17782
17782
|
},
|
|
17783
17783
|
{
|
|
17784
17784
|
"kind": "javascript-module",
|
|
17785
|
-
"path": "src/
|
|
17785
|
+
"path": "src/tooltip/Tooltip.ts",
|
|
17786
17786
|
"declarations": [
|
|
17787
17787
|
{
|
|
17788
17788
|
"kind": "class",
|
|
17789
|
-
"description": "
|
|
17790
|
-
"name": "
|
|
17789
|
+
"description": "Tooltips are floating containers for displaying additional information\nfor the currently focused element. A tooltip can be useful when you want\nto e.g. give a hint about an existing Command Menu shortcut.",
|
|
17790
|
+
"name": "Tooltip",
|
|
17791
17791
|
"cssProperties": [
|
|
17792
17792
|
{
|
|
17793
|
-
"description": "Controls the
|
|
17794
|
-
"name": "--n-
|
|
17795
|
-
"default": "
|
|
17793
|
+
"description": "Controls the maximum inline size, or width, of the tooltip.",
|
|
17794
|
+
"name": "--n-tooltip-max-size",
|
|
17795
|
+
"default": "50ch"
|
|
17796
17796
|
}
|
|
17797
17797
|
],
|
|
17798
17798
|
"slots": [
|
|
17799
17799
|
{
|
|
17800
|
-
"description": "
|
|
17801
|
-
"name": "
|
|
17802
|
-
},
|
|
17803
|
-
{
|
|
17804
|
-
"description": "Optional slot that holds hint text for the input.",
|
|
17805
|
-
"name": "hint"
|
|
17800
|
+
"description": "The tooltip content",
|
|
17801
|
+
"name": ""
|
|
17806
17802
|
},
|
|
17807
17803
|
{
|
|
17808
|
-
"description": "Optional slot that holds
|
|
17809
|
-
"name": "
|
|
17804
|
+
"description": "Optional slot that holds shortcut keys to access the subject",
|
|
17805
|
+
"name": "shortcut"
|
|
17810
17806
|
}
|
|
17811
17807
|
],
|
|
17812
17808
|
"members": [
|
|
17813
17809
|
{
|
|
17814
17810
|
"kind": "field",
|
|
17815
|
-
"name": "
|
|
17816
|
-
"privacy": "protected",
|
|
17817
|
-
"readonly": true,
|
|
17818
|
-
"inheritedFrom": {
|
|
17819
|
-
"name": "FormAssociatedMixin",
|
|
17820
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17821
|
-
}
|
|
17822
|
-
},
|
|
17823
|
-
{
|
|
17824
|
-
"kind": "field",
|
|
17825
|
-
"name": "checked",
|
|
17811
|
+
"name": "lastOpened",
|
|
17826
17812
|
"type": {
|
|
17827
|
-
"text": "
|
|
17813
|
+
"text": "Tooltip | undefined"
|
|
17828
17814
|
},
|
|
17829
|
-
"
|
|
17830
|
-
"
|
|
17831
|
-
"attribute": "checked",
|
|
17832
|
-
"reflects": true
|
|
17815
|
+
"privacy": "private",
|
|
17816
|
+
"static": true
|
|
17833
17817
|
},
|
|
17834
17818
|
{
|
|
17835
17819
|
"kind": "field",
|
|
17836
|
-
"name": "
|
|
17837
|
-
"
|
|
17838
|
-
|
|
17839
|
-
},
|
|
17840
|
-
"default": "false",
|
|
17841
|
-
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
17842
|
-
"attribute": "reverse",
|
|
17843
|
-
"reflects": true
|
|
17820
|
+
"name": "shortcutSlot",
|
|
17821
|
+
"privacy": "private",
|
|
17822
|
+
"default": "new SlotController(this, 'shortcut')"
|
|
17844
17823
|
},
|
|
17845
17824
|
{
|
|
17846
17825
|
"kind": "field",
|
|
17847
|
-
"name": "
|
|
17848
|
-
"
|
|
17849
|
-
|
|
17850
|
-
},
|
|
17851
|
-
"default": "'m'",
|
|
17852
|
-
"description": "The size of the toggle switch.",
|
|
17853
|
-
"attribute": "size",
|
|
17854
|
-
"reflects": true
|
|
17855
|
-
},
|
|
17856
|
-
{
|
|
17857
|
-
"kind": "method",
|
|
17858
|
-
"name": "handleChange",
|
|
17859
|
-
"privacy": "protected",
|
|
17860
|
-
"parameters": [
|
|
17861
|
-
{
|
|
17862
|
-
"name": "e",
|
|
17863
|
-
"type": {
|
|
17864
|
-
"text": "Event"
|
|
17865
|
-
}
|
|
17866
|
-
}
|
|
17867
|
-
],
|
|
17868
|
-
"return": {
|
|
17869
|
-
"type": {
|
|
17870
|
-
"text": "void"
|
|
17871
|
-
}
|
|
17872
|
-
},
|
|
17873
|
-
"inheritedFrom": {
|
|
17874
|
-
"name": "FormAssociatedMixin",
|
|
17875
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17876
|
-
}
|
|
17826
|
+
"name": "events",
|
|
17827
|
+
"privacy": "private",
|
|
17828
|
+
"default": "new EventController(this)"
|
|
17877
17829
|
},
|
|
17878
17830
|
{
|
|
17879
17831
|
"kind": "field",
|
|
17880
|
-
"name": "
|
|
17881
|
-
"
|
|
17882
|
-
|
|
17883
|
-
|
|
17884
|
-
|
|
17885
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17886
|
-
}
|
|
17832
|
+
"name": "currentElement",
|
|
17833
|
+
"type": {
|
|
17834
|
+
"text": "FocusableElement | undefined"
|
|
17835
|
+
},
|
|
17836
|
+
"privacy": "private"
|
|
17887
17837
|
},
|
|
17888
17838
|
{
|
|
17889
17839
|
"kind": "field",
|
|
17890
|
-
"name": "
|
|
17891
|
-
"
|
|
17892
|
-
|
|
17893
|
-
|
|
17894
|
-
|
|
17895
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17896
|
-
}
|
|
17840
|
+
"name": "timeoutId",
|
|
17841
|
+
"type": {
|
|
17842
|
+
"text": "ReturnType<typeof setTimeout> | undefined"
|
|
17843
|
+
},
|
|
17844
|
+
"privacy": "private"
|
|
17897
17845
|
},
|
|
17898
17846
|
{
|
|
17899
17847
|
"kind": "field",
|
|
17900
|
-
"name": "
|
|
17901
|
-
"
|
|
17902
|
-
|
|
17903
|
-
|
|
17904
|
-
|
|
17905
|
-
|
|
17906
|
-
}
|
|
17848
|
+
"name": "proxy",
|
|
17849
|
+
"type": {
|
|
17850
|
+
"text": "HTMLSpanElement | undefined"
|
|
17851
|
+
},
|
|
17852
|
+
"privacy": "private",
|
|
17853
|
+
"description": "the proxy element is for cases where the targetElement is a web component,\nand the WC has a focusable child in its shadow root e.g. a button component.\nin this case, when the tooltip is shown, we inject the proxy into targetElement's shadow root\nand wire up aria-describedby from the focusable element to the proxy.\nwhen the tooltip is hidden, we remove the proxy and remove the aria-describedby relationship."
|
|
17907
17854
|
},
|
|
17908
17855
|
{
|
|
17909
17856
|
"kind": "field",
|
|
17910
|
-
"name": "
|
|
17911
|
-
"
|
|
17912
|
-
|
|
17913
|
-
|
|
17914
|
-
|
|
17915
|
-
|
|
17916
|
-
|
|
17857
|
+
"name": "state",
|
|
17858
|
+
"type": {
|
|
17859
|
+
"text": "TooltipStates"
|
|
17860
|
+
},
|
|
17861
|
+
"privacy": "private",
|
|
17862
|
+
"default": "'hidden'",
|
|
17863
|
+
"description": "The current state of the tooltip, dependent on the state machine"
|
|
17917
17864
|
},
|
|
17918
17865
|
{
|
|
17919
17866
|
"kind": "field",
|
|
17920
|
-
"name": "
|
|
17867
|
+
"name": "coords",
|
|
17921
17868
|
"type": {
|
|
17922
|
-
"text": "
|
|
17869
|
+
"text": "[number, number]"
|
|
17923
17870
|
},
|
|
17924
|
-
"privacy": "
|
|
17925
|
-
"default": "
|
|
17926
|
-
"inheritedFrom": {
|
|
17927
|
-
"name": "FormAssociatedMixin",
|
|
17928
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17929
|
-
}
|
|
17871
|
+
"privacy": "private",
|
|
17872
|
+
"default": "[0, 0]"
|
|
17930
17873
|
},
|
|
17931
17874
|
{
|
|
17932
17875
|
"kind": "field",
|
|
17933
|
-
"name": "
|
|
17876
|
+
"name": "position",
|
|
17934
17877
|
"type": {
|
|
17935
|
-
"text": "
|
|
17878
|
+
"text": "'block-end' | 'block-start' | 'inline-start' | 'inline-end'"
|
|
17936
17879
|
},
|
|
17937
|
-
"
|
|
17938
|
-
"
|
|
17939
|
-
"
|
|
17940
|
-
|
|
17941
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17942
|
-
}
|
|
17880
|
+
"default": "'block-start'",
|
|
17881
|
+
"description": "Control the position of the tooltip component.\nWhen set to \"none\", the tooltip will be shown above\nbut accommodate for browser boundaries.",
|
|
17882
|
+
"attribute": "position",
|
|
17883
|
+
"reflects": true
|
|
17943
17884
|
},
|
|
17944
17885
|
{
|
|
17945
17886
|
"kind": "field",
|
|
17946
|
-
"name": "
|
|
17887
|
+
"name": "role",
|
|
17947
17888
|
"type": {
|
|
17948
17889
|
"text": "string"
|
|
17949
17890
|
},
|
|
17950
|
-
"
|
|
17951
|
-
"
|
|
17952
|
-
"
|
|
17953
|
-
|
|
17954
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17955
|
-
}
|
|
17891
|
+
"default": "'tooltip'",
|
|
17892
|
+
"description": "The tooltip role, set on the component by default.",
|
|
17893
|
+
"attribute": "role",
|
|
17894
|
+
"reflects": true
|
|
17956
17895
|
},
|
|
17957
17896
|
{
|
|
17958
17897
|
"kind": "field",
|
|
17959
|
-
"name": "
|
|
17898
|
+
"name": "id",
|
|
17960
17899
|
"type": {
|
|
17961
17900
|
"text": "string"
|
|
17962
17901
|
},
|
|
17963
17902
|
"default": "''",
|
|
17964
|
-
"description": "
|
|
17965
|
-
"attribute": "
|
|
17966
|
-
"reflects": true
|
|
17967
|
-
"inheritedFrom": {
|
|
17968
|
-
"name": "FormAssociatedMixin",
|
|
17969
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17970
|
-
}
|
|
17903
|
+
"description": "The id for the active element to reference via aria-describedby.",
|
|
17904
|
+
"attribute": "id",
|
|
17905
|
+
"reflects": true
|
|
17971
17906
|
},
|
|
17972
17907
|
{
|
|
17973
17908
|
"kind": "field",
|
|
17974
|
-
"name": "
|
|
17909
|
+
"name": "delay",
|
|
17975
17910
|
"type": {
|
|
17976
|
-
"text": "
|
|
17911
|
+
"text": "number"
|
|
17977
17912
|
},
|
|
17978
|
-
"
|
|
17979
|
-
"
|
|
17980
|
-
"
|
|
17981
|
-
"
|
|
17982
|
-
|
|
17983
|
-
|
|
17984
|
-
|
|
17913
|
+
"default": "500",
|
|
17914
|
+
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
17915
|
+
"attribute": "delay",
|
|
17916
|
+
"reflects": true
|
|
17917
|
+
},
|
|
17918
|
+
{
|
|
17919
|
+
"kind": "method",
|
|
17920
|
+
"name": "handleIdChange",
|
|
17921
|
+
"privacy": "protected"
|
|
17922
|
+
},
|
|
17923
|
+
{
|
|
17924
|
+
"kind": "method",
|
|
17925
|
+
"name": "handleStateChange",
|
|
17926
|
+
"privacy": "private",
|
|
17927
|
+
"parameters": [
|
|
17928
|
+
{
|
|
17929
|
+
"name": "prevState",
|
|
17930
|
+
"type": {
|
|
17931
|
+
"text": "TooltipStates"
|
|
17932
|
+
}
|
|
17933
|
+
}
|
|
17934
|
+
]
|
|
17985
17935
|
},
|
|
17986
17936
|
{
|
|
17987
17937
|
"kind": "field",
|
|
17988
|
-
"name": "
|
|
17938
|
+
"name": "updatePosition",
|
|
17939
|
+
"privacy": "private",
|
|
17940
|
+
"description": "Setting and updating the position of the tooltip"
|
|
17941
|
+
},
|
|
17942
|
+
{
|
|
17943
|
+
"kind": "field",
|
|
17944
|
+
"name": "hideTooltip",
|
|
17945
|
+
"privacy": "private"
|
|
17946
|
+
},
|
|
17947
|
+
{
|
|
17948
|
+
"kind": "field",
|
|
17949
|
+
"name": "reposition",
|
|
17950
|
+
"privacy": "private"
|
|
17951
|
+
},
|
|
17952
|
+
{
|
|
17953
|
+
"kind": "field",
|
|
17954
|
+
"name": "handleShow",
|
|
17955
|
+
"privacy": "private"
|
|
17956
|
+
},
|
|
17957
|
+
{
|
|
17958
|
+
"kind": "field",
|
|
17959
|
+
"name": "handleHide",
|
|
17960
|
+
"privacy": "private"
|
|
17961
|
+
},
|
|
17962
|
+
{
|
|
17963
|
+
"kind": "field",
|
|
17964
|
+
"name": "hideOnEscape",
|
|
17965
|
+
"privacy": "private"
|
|
17966
|
+
},
|
|
17967
|
+
{
|
|
17968
|
+
"kind": "field",
|
|
17969
|
+
"name": "addDescribedBy",
|
|
17970
|
+
"privacy": "private"
|
|
17971
|
+
},
|
|
17972
|
+
{
|
|
17973
|
+
"kind": "field",
|
|
17974
|
+
"name": "removeDescribedBy",
|
|
17975
|
+
"privacy": "private"
|
|
17976
|
+
}
|
|
17977
|
+
],
|
|
17978
|
+
"attributes": [
|
|
17979
|
+
{
|
|
17980
|
+
"name": "position",
|
|
17989
17981
|
"type": {
|
|
17990
|
-
"text": "
|
|
17982
|
+
"text": "'block-end' | 'block-start' | 'inline-start' | 'inline-end'"
|
|
17991
17983
|
},
|
|
17992
|
-
"default": "
|
|
17993
|
-
"description": "
|
|
17994
|
-
"
|
|
17995
|
-
"reflects": true,
|
|
17996
|
-
"inheritedFrom": {
|
|
17997
|
-
"name": "FormAssociatedMixin",
|
|
17998
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
17999
|
-
}
|
|
17984
|
+
"default": "'block-start'",
|
|
17985
|
+
"description": "Control the position of the tooltip component.\nWhen set to \"none\", the tooltip will be shown above\nbut accommodate for browser boundaries.",
|
|
17986
|
+
"fieldName": "position"
|
|
18000
17987
|
},
|
|
18001
17988
|
{
|
|
18002
|
-
"
|
|
18003
|
-
"name": "placeholder",
|
|
17989
|
+
"name": "role",
|
|
18004
17990
|
"type": {
|
|
18005
|
-
"text": "string
|
|
17991
|
+
"text": "string"
|
|
18006
17992
|
},
|
|
18007
|
-
"
|
|
18008
|
-
"
|
|
18009
|
-
"
|
|
18010
|
-
"inheritedFrom": {
|
|
18011
|
-
"name": "FormAssociatedMixin",
|
|
18012
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18013
|
-
}
|
|
17993
|
+
"default": "'tooltip'",
|
|
17994
|
+
"description": "The tooltip role, set on the component by default.",
|
|
17995
|
+
"fieldName": "role"
|
|
18014
17996
|
},
|
|
18015
17997
|
{
|
|
18016
|
-
"
|
|
18017
|
-
"name": "error",
|
|
17998
|
+
"name": "id",
|
|
18018
17999
|
"type": {
|
|
18019
|
-
"text": "string
|
|
18000
|
+
"text": "string"
|
|
18020
18001
|
},
|
|
18021
|
-
"
|
|
18022
|
-
"
|
|
18023
|
-
"
|
|
18002
|
+
"default": "''",
|
|
18003
|
+
"description": "The id for the active element to reference via aria-describedby.",
|
|
18004
|
+
"fieldName": "id"
|
|
18005
|
+
},
|
|
18006
|
+
{
|
|
18007
|
+
"name": "delay",
|
|
18008
|
+
"type": {
|
|
18009
|
+
"text": "number"
|
|
18010
|
+
},
|
|
18011
|
+
"default": "500",
|
|
18012
|
+
"description": "The delay in milliseconds before the tooltip is opened.",
|
|
18013
|
+
"fieldName": "delay"
|
|
18014
|
+
}
|
|
18015
|
+
],
|
|
18016
|
+
"superclass": {
|
|
18017
|
+
"name": "LitElement",
|
|
18018
|
+
"package": "lit"
|
|
18019
|
+
},
|
|
18020
|
+
"localization": [],
|
|
18021
|
+
"status": "ready",
|
|
18022
|
+
"category": "overlay",
|
|
18023
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use a tooltip if an interactive element requires more explanation.\n- Use a tooltip to provide additional information, such as UI shortcuts.\n- Use the `label` attribute on icons used for shortcuts for accessibility.\n- Use clear and accurate phrasing.\n- Be consistent with positioning of tooltips in the user interface.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Don’t use interactive elements such as links or buttons inside a tooltip.\n- Don’t rely on tooltips when you have room to provide more explanation.\n- Don’t depend on tooltips for vital information.\n\n</div>\n\n---\n\n## Content guidelines\n\nTooltips should be clear and informative, but not imperative to using the interface they refer to. They should not contain interactive elements such as buttons or links.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data as a CSV, <u>more information on CSVs</u></div>\n\nTooltips should provide useful information and not repeat information that is already present.\n\n<div class=\"n-usage n-usage-do\">Export – Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export – Export data</div>\n\nWhen writing tooltips, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">Export data as a spreadsheet</div>\n<div class=\"n-usage n-usage-dont\">Export Data As a Spreadsheet</div>\n\nUse tooltips sparingly. If your UI is requiring a lot of tooltips, consider revising the interface to provide better explanations and better labelling.\n\n---\n\n## Additional considerations\n\n- Always provide a tooltip for icon-only buttons or a button with an associated keyboard shortcut.\n- Don’t use tooltip to communicate critical information, including errors.\n- Use sparingly. If you’re building something that requires a lot of tooltips, take a step back and work on clarifying the design and the language used instead.\n",
|
|
18024
|
+
"examples": [],
|
|
18025
|
+
"dependencies": [],
|
|
18026
|
+
"tagName": "nord-tooltip",
|
|
18027
|
+
"customElement": true
|
|
18028
|
+
}
|
|
18029
|
+
],
|
|
18030
|
+
"exports": [
|
|
18031
|
+
{
|
|
18032
|
+
"kind": "js",
|
|
18033
|
+
"name": "default",
|
|
18034
|
+
"declaration": {
|
|
18035
|
+
"name": "Tooltip",
|
|
18036
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
18037
|
+
}
|
|
18038
|
+
},
|
|
18039
|
+
{
|
|
18040
|
+
"kind": "custom-element-definition",
|
|
18041
|
+
"name": "nord-tooltip",
|
|
18042
|
+
"declaration": {
|
|
18043
|
+
"name": "Tooltip",
|
|
18044
|
+
"module": "src/tooltip/Tooltip.ts"
|
|
18045
|
+
}
|
|
18046
|
+
}
|
|
18047
|
+
]
|
|
18048
|
+
},
|
|
18049
|
+
{
|
|
18050
|
+
"kind": "javascript-module",
|
|
18051
|
+
"path": "src/toggle/Toggle.ts",
|
|
18052
|
+
"declarations": [
|
|
18053
|
+
{
|
|
18054
|
+
"kind": "class",
|
|
18055
|
+
"description": "Toggle switch gives control over a feature or option that can be\nturned on or off. If a physical switch would work for the action, a\ntoggle is probably the best component to use.",
|
|
18056
|
+
"name": "Toggle",
|
|
18057
|
+
"cssProperties": [
|
|
18058
|
+
{
|
|
18059
|
+
"description": "Controls the text color of the label, using our [color tokens](/tokens/#color).",
|
|
18060
|
+
"name": "--n-label-color",
|
|
18061
|
+
"default": "var(--n-color-text)"
|
|
18062
|
+
}
|
|
18063
|
+
],
|
|
18064
|
+
"slots": [
|
|
18065
|
+
{
|
|
18066
|
+
"description": "Use when a label requires more than plain text.",
|
|
18067
|
+
"name": "label"
|
|
18068
|
+
},
|
|
18069
|
+
{
|
|
18070
|
+
"description": "Optional slot that holds hint text for the input.",
|
|
18071
|
+
"name": "hint"
|
|
18072
|
+
},
|
|
18073
|
+
{
|
|
18074
|
+
"description": "Optional slot that holds error text for the input.",
|
|
18075
|
+
"name": "error"
|
|
18076
|
+
}
|
|
18077
|
+
],
|
|
18078
|
+
"members": [
|
|
18079
|
+
{
|
|
18080
|
+
"kind": "field",
|
|
18081
|
+
"name": "formValue",
|
|
18082
|
+
"privacy": "protected",
|
|
18083
|
+
"readonly": true,
|
|
18024
18084
|
"inheritedFrom": {
|
|
18025
18085
|
"name": "FormAssociatedMixin",
|
|
18026
18086
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -18028,37 +18088,40 @@
|
|
|
18028
18088
|
},
|
|
18029
18089
|
{
|
|
18030
18090
|
"kind": "field",
|
|
18031
|
-
"name": "
|
|
18091
|
+
"name": "checked",
|
|
18032
18092
|
"type": {
|
|
18033
18093
|
"text": "boolean"
|
|
18034
18094
|
},
|
|
18035
18095
|
"default": "false",
|
|
18036
|
-
"description": "
|
|
18037
|
-
"attribute": "
|
|
18038
|
-
"reflects": true
|
|
18039
|
-
"inheritedFrom": {
|
|
18040
|
-
"name": "FormAssociatedMixin",
|
|
18041
|
-
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18042
|
-
}
|
|
18096
|
+
"description": "Controls whether the toggle is checked or not.",
|
|
18097
|
+
"attribute": "checked",
|
|
18098
|
+
"reflects": true
|
|
18043
18099
|
},
|
|
18044
18100
|
{
|
|
18045
18101
|
"kind": "field",
|
|
18046
|
-
"name": "
|
|
18102
|
+
"name": "reverse",
|
|
18047
18103
|
"type": {
|
|
18048
18104
|
"text": "boolean"
|
|
18049
18105
|
},
|
|
18050
18106
|
"default": "false",
|
|
18051
|
-
"description": "
|
|
18052
|
-
"attribute": "
|
|
18053
|
-
"reflects": true
|
|
18054
|
-
|
|
18055
|
-
|
|
18056
|
-
|
|
18057
|
-
|
|
18107
|
+
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
18108
|
+
"attribute": "reverse",
|
|
18109
|
+
"reflects": true
|
|
18110
|
+
},
|
|
18111
|
+
{
|
|
18112
|
+
"kind": "field",
|
|
18113
|
+
"name": "size",
|
|
18114
|
+
"type": {
|
|
18115
|
+
"text": "'s' | 'm' | 'l'"
|
|
18116
|
+
},
|
|
18117
|
+
"default": "'m'",
|
|
18118
|
+
"description": "The size of the toggle switch.",
|
|
18119
|
+
"attribute": "size",
|
|
18120
|
+
"reflects": true
|
|
18058
18121
|
},
|
|
18059
18122
|
{
|
|
18060
18123
|
"kind": "method",
|
|
18061
|
-
"name": "
|
|
18124
|
+
"name": "handleChange",
|
|
18062
18125
|
"privacy": "protected",
|
|
18063
18126
|
"parameters": [
|
|
18064
18127
|
{
|
|
@@ -18068,51 +18131,51 @@
|
|
|
18068
18131
|
}
|
|
18069
18132
|
}
|
|
18070
18133
|
],
|
|
18134
|
+
"return": {
|
|
18135
|
+
"type": {
|
|
18136
|
+
"text": "void"
|
|
18137
|
+
}
|
|
18138
|
+
},
|
|
18071
18139
|
"inheritedFrom": {
|
|
18072
18140
|
"name": "FormAssociatedMixin",
|
|
18073
18141
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18074
18142
|
}
|
|
18075
18143
|
},
|
|
18076
18144
|
{
|
|
18077
|
-
"kind": "
|
|
18078
|
-
"name": "
|
|
18145
|
+
"kind": "field",
|
|
18146
|
+
"name": "labelSlot",
|
|
18079
18147
|
"privacy": "protected",
|
|
18080
|
-
"
|
|
18081
|
-
{
|
|
18082
|
-
"name": "additionalContent",
|
|
18083
|
-
"optional": true,
|
|
18084
|
-
"type": {
|
|
18085
|
-
"text": "TemplateResult"
|
|
18086
|
-
}
|
|
18087
|
-
}
|
|
18088
|
-
],
|
|
18148
|
+
"default": "new SlotController(this, 'label')",
|
|
18089
18149
|
"inheritedFrom": {
|
|
18090
18150
|
"name": "FormAssociatedMixin",
|
|
18091
18151
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18092
18152
|
}
|
|
18093
18153
|
},
|
|
18094
18154
|
{
|
|
18095
|
-
"kind": "
|
|
18096
|
-
"name": "
|
|
18155
|
+
"kind": "field",
|
|
18156
|
+
"name": "errorSlot",
|
|
18097
18157
|
"privacy": "protected",
|
|
18158
|
+
"default": "new SlotController(this, 'error')",
|
|
18098
18159
|
"inheritedFrom": {
|
|
18099
18160
|
"name": "FormAssociatedMixin",
|
|
18100
18161
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18101
18162
|
}
|
|
18102
18163
|
},
|
|
18103
18164
|
{
|
|
18104
|
-
"kind": "
|
|
18105
|
-
"name": "
|
|
18165
|
+
"kind": "field",
|
|
18166
|
+
"name": "hintSlot",
|
|
18106
18167
|
"privacy": "protected",
|
|
18168
|
+
"default": "new SlotController(this, 'hint')",
|
|
18107
18169
|
"inheritedFrom": {
|
|
18108
18170
|
"name": "FormAssociatedMixin",
|
|
18109
18171
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18110
18172
|
}
|
|
18111
18173
|
},
|
|
18112
18174
|
{
|
|
18113
|
-
"kind": "
|
|
18114
|
-
"name": "
|
|
18175
|
+
"kind": "field",
|
|
18176
|
+
"name": "formData",
|
|
18115
18177
|
"privacy": "protected",
|
|
18178
|
+
"default": "new FormDataController(this, { value: () => this.formValue })",
|
|
18116
18179
|
"inheritedFrom": {
|
|
18117
18180
|
"name": "FormAssociatedMixin",
|
|
18118
18181
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -18120,9 +18183,12 @@
|
|
|
18120
18183
|
},
|
|
18121
18184
|
{
|
|
18122
18185
|
"kind": "field",
|
|
18123
|
-
"name": "
|
|
18186
|
+
"name": "inputId",
|
|
18187
|
+
"type": {
|
|
18188
|
+
"text": "string"
|
|
18189
|
+
},
|
|
18124
18190
|
"privacy": "protected",
|
|
18125
|
-
"
|
|
18191
|
+
"default": "'input'",
|
|
18126
18192
|
"inheritedFrom": {
|
|
18127
18193
|
"name": "FormAssociatedMixin",
|
|
18128
18194
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -18130,9 +18196,12 @@
|
|
|
18130
18196
|
},
|
|
18131
18197
|
{
|
|
18132
18198
|
"kind": "field",
|
|
18133
|
-
"name": "
|
|
18199
|
+
"name": "errorId",
|
|
18200
|
+
"type": {
|
|
18201
|
+
"text": "string"
|
|
18202
|
+
},
|
|
18134
18203
|
"privacy": "protected",
|
|
18135
|
-
"
|
|
18204
|
+
"default": "'error'",
|
|
18136
18205
|
"inheritedFrom": {
|
|
18137
18206
|
"name": "FormAssociatedMixin",
|
|
18138
18207
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
@@ -18140,601 +18209,508 @@
|
|
|
18140
18209
|
},
|
|
18141
18210
|
{
|
|
18142
18211
|
"kind": "field",
|
|
18143
|
-
"name": "
|
|
18212
|
+
"name": "hintId",
|
|
18144
18213
|
"type": {
|
|
18145
|
-
"text": "
|
|
18214
|
+
"text": "string"
|
|
18146
18215
|
},
|
|
18147
|
-
"
|
|
18148
|
-
"
|
|
18149
|
-
"attribute": "disabled",
|
|
18150
|
-
"reflects": true,
|
|
18216
|
+
"privacy": "protected",
|
|
18217
|
+
"default": "'hint'",
|
|
18151
18218
|
"inheritedFrom": {
|
|
18152
|
-
"name": "
|
|
18153
|
-
"module": "src/common/mixins/
|
|
18219
|
+
"name": "FormAssociatedMixin",
|
|
18220
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18154
18221
|
}
|
|
18155
18222
|
},
|
|
18156
18223
|
{
|
|
18157
18224
|
"kind": "field",
|
|
18158
|
-
"name": "
|
|
18225
|
+
"name": "label",
|
|
18159
18226
|
"type": {
|
|
18160
|
-
"text": "string
|
|
18227
|
+
"text": "string"
|
|
18161
18228
|
},
|
|
18162
|
-
"
|
|
18163
|
-
"
|
|
18229
|
+
"default": "''",
|
|
18230
|
+
"description": "Label for the input.",
|
|
18231
|
+
"attribute": "label",
|
|
18164
18232
|
"reflects": true,
|
|
18165
18233
|
"inheritedFrom": {
|
|
18166
|
-
"name": "
|
|
18167
|
-
"module": "src/common/mixins/
|
|
18234
|
+
"name": "FormAssociatedMixin",
|
|
18235
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18168
18236
|
}
|
|
18169
18237
|
},
|
|
18170
18238
|
{
|
|
18171
18239
|
"kind": "field",
|
|
18172
|
-
"name": "
|
|
18240
|
+
"name": "hint",
|
|
18173
18241
|
"type": {
|
|
18174
|
-
"text": "string"
|
|
18242
|
+
"text": "string | undefined"
|
|
18175
18243
|
},
|
|
18176
|
-
"
|
|
18177
|
-
"
|
|
18178
|
-
"
|
|
18244
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
18245
|
+
"attribute": "hint",
|
|
18246
|
+
"reflects": true,
|
|
18179
18247
|
"inheritedFrom": {
|
|
18180
|
-
"name": "
|
|
18181
|
-
"module": "src/common/mixins/
|
|
18248
|
+
"name": "FormAssociatedMixin",
|
|
18249
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18182
18250
|
}
|
|
18183
18251
|
},
|
|
18184
18252
|
{
|
|
18185
18253
|
"kind": "field",
|
|
18186
|
-
"name": "
|
|
18254
|
+
"name": "hideLabel",
|
|
18187
18255
|
"type": {
|
|
18188
|
-
"text": "
|
|
18256
|
+
"text": "boolean"
|
|
18189
18257
|
},
|
|
18190
|
-
"
|
|
18191
|
-
"
|
|
18258
|
+
"default": "false",
|
|
18259
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
18260
|
+
"attribute": "hide-label",
|
|
18261
|
+
"reflects": true,
|
|
18192
18262
|
"inheritedFrom": {
|
|
18193
|
-
"name": "
|
|
18194
|
-
"module": "src/common/mixins/
|
|
18263
|
+
"name": "FormAssociatedMixin",
|
|
18264
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18195
18265
|
}
|
|
18196
18266
|
},
|
|
18197
18267
|
{
|
|
18198
18268
|
"kind": "field",
|
|
18199
|
-
"name": "
|
|
18269
|
+
"name": "placeholder",
|
|
18200
18270
|
"type": {
|
|
18201
18271
|
"text": "string | undefined"
|
|
18202
18272
|
},
|
|
18203
|
-
"
|
|
18273
|
+
"description": "Placeholder text to display within the input.",
|
|
18274
|
+
"attribute": "placeholder",
|
|
18275
|
+
"reflects": true,
|
|
18204
18276
|
"inheritedFrom": {
|
|
18205
|
-
"name": "
|
|
18206
|
-
"module": "src/common/mixins/
|
|
18277
|
+
"name": "FormAssociatedMixin",
|
|
18278
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18207
18279
|
}
|
|
18208
18280
|
},
|
|
18209
18281
|
{
|
|
18210
18282
|
"kind": "field",
|
|
18211
|
-
"name": "
|
|
18283
|
+
"name": "error",
|
|
18212
18284
|
"type": {
|
|
18213
|
-
"text": "
|
|
18285
|
+
"text": "string | undefined"
|
|
18214
18286
|
},
|
|
18215
|
-
"description": "
|
|
18216
|
-
"attribute": "
|
|
18287
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
18288
|
+
"attribute": "error",
|
|
18289
|
+
"reflects": true,
|
|
18217
18290
|
"inheritedFrom": {
|
|
18218
|
-
"name": "
|
|
18219
|
-
"module": "src/common/mixins/
|
|
18291
|
+
"name": "FormAssociatedMixin",
|
|
18292
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18220
18293
|
}
|
|
18221
18294
|
},
|
|
18222
18295
|
{
|
|
18223
18296
|
"kind": "field",
|
|
18224
|
-
"name": "
|
|
18225
|
-
"privacy": "protected",
|
|
18226
|
-
"inheritedFrom": {
|
|
18227
|
-
"name": "FocusableMixin",
|
|
18228
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18229
|
-
}
|
|
18230
|
-
},
|
|
18231
|
-
{
|
|
18232
|
-
"kind": "method",
|
|
18233
|
-
"name": "focus",
|
|
18234
|
-
"parameters": [
|
|
18235
|
-
{
|
|
18236
|
-
"name": "options",
|
|
18237
|
-
"optional": true,
|
|
18238
|
-
"type": {
|
|
18239
|
-
"text": "FocusOptions"
|
|
18240
|
-
},
|
|
18241
|
-
"description": "An object which controls aspects of the focusing process."
|
|
18242
|
-
}
|
|
18243
|
-
],
|
|
18244
|
-
"description": "Programmatically move focus to the component.",
|
|
18245
|
-
"inheritedFrom": {
|
|
18246
|
-
"name": "FocusableMixin",
|
|
18247
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18248
|
-
}
|
|
18249
|
-
},
|
|
18250
|
-
{
|
|
18251
|
-
"kind": "method",
|
|
18252
|
-
"name": "blur",
|
|
18253
|
-
"description": "Programmatically remove focus from the component.",
|
|
18254
|
-
"inheritedFrom": {
|
|
18255
|
-
"name": "FocusableMixin",
|
|
18256
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18257
|
-
}
|
|
18258
|
-
},
|
|
18259
|
-
{
|
|
18260
|
-
"kind": "method",
|
|
18261
|
-
"name": "click",
|
|
18262
|
-
"description": "Programmatically simulates a click on the component.",
|
|
18263
|
-
"inheritedFrom": {
|
|
18264
|
-
"name": "FocusableMixin",
|
|
18265
|
-
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18266
|
-
}
|
|
18267
|
-
}
|
|
18268
|
-
],
|
|
18269
|
-
"attributes": [
|
|
18270
|
-
{
|
|
18271
|
-
"name": "checked",
|
|
18297
|
+
"name": "required",
|
|
18272
18298
|
"type": {
|
|
18273
18299
|
"text": "boolean"
|
|
18274
18300
|
},
|
|
18275
18301
|
"default": "false",
|
|
18276
|
-
"description": "
|
|
18277
|
-
"
|
|
18302
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
18303
|
+
"attribute": "required",
|
|
18304
|
+
"reflects": true,
|
|
18305
|
+
"inheritedFrom": {
|
|
18306
|
+
"name": "FormAssociatedMixin",
|
|
18307
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18308
|
+
}
|
|
18278
18309
|
},
|
|
18279
18310
|
{
|
|
18280
|
-
"
|
|
18311
|
+
"kind": "field",
|
|
18312
|
+
"name": "hideRequired",
|
|
18281
18313
|
"type": {
|
|
18282
18314
|
"text": "boolean"
|
|
18283
18315
|
},
|
|
18284
18316
|
"default": "false",
|
|
18285
|
-
"description": "
|
|
18286
|
-
"
|
|
18287
|
-
|
|
18288
|
-
{
|
|
18289
|
-
"name": "size",
|
|
18290
|
-
"type": {
|
|
18291
|
-
"text": "'s' | 'm' | 'l'"
|
|
18292
|
-
},
|
|
18293
|
-
"default": "'m'",
|
|
18294
|
-
"description": "The size of the toggle switch.",
|
|
18295
|
-
"fieldName": "size"
|
|
18296
|
-
},
|
|
18297
|
-
{
|
|
18298
|
-
"name": "label",
|
|
18299
|
-
"type": {
|
|
18300
|
-
"text": "string"
|
|
18301
|
-
},
|
|
18302
|
-
"default": "''",
|
|
18303
|
-
"description": "Label for the input.",
|
|
18304
|
-
"fieldName": "label",
|
|
18317
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
18318
|
+
"attribute": "hide-required",
|
|
18319
|
+
"reflects": true,
|
|
18305
18320
|
"inheritedFrom": {
|
|
18306
18321
|
"name": "FormAssociatedMixin",
|
|
18307
18322
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18308
18323
|
}
|
|
18309
18324
|
},
|
|
18310
18325
|
{
|
|
18311
|
-
"
|
|
18312
|
-
"
|
|
18313
|
-
|
|
18314
|
-
|
|
18315
|
-
|
|
18316
|
-
|
|
18326
|
+
"kind": "method",
|
|
18327
|
+
"name": "handleInput",
|
|
18328
|
+
"privacy": "protected",
|
|
18329
|
+
"parameters": [
|
|
18330
|
+
{
|
|
18331
|
+
"name": "e",
|
|
18332
|
+
"type": {
|
|
18333
|
+
"text": "Event"
|
|
18334
|
+
}
|
|
18335
|
+
}
|
|
18336
|
+
],
|
|
18317
18337
|
"inheritedFrom": {
|
|
18318
18338
|
"name": "FormAssociatedMixin",
|
|
18319
18339
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18320
18340
|
}
|
|
18321
18341
|
},
|
|
18322
18342
|
{
|
|
18323
|
-
"
|
|
18324
|
-
"
|
|
18325
|
-
|
|
18326
|
-
|
|
18327
|
-
|
|
18328
|
-
|
|
18329
|
-
|
|
18343
|
+
"kind": "method",
|
|
18344
|
+
"name": "renderLabel",
|
|
18345
|
+
"privacy": "protected",
|
|
18346
|
+
"parameters": [
|
|
18347
|
+
{
|
|
18348
|
+
"name": "additionalContent",
|
|
18349
|
+
"optional": true,
|
|
18350
|
+
"type": {
|
|
18351
|
+
"text": "TemplateResult"
|
|
18352
|
+
}
|
|
18353
|
+
}
|
|
18354
|
+
],
|
|
18330
18355
|
"inheritedFrom": {
|
|
18331
18356
|
"name": "FormAssociatedMixin",
|
|
18332
18357
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18333
18358
|
}
|
|
18334
18359
|
},
|
|
18335
18360
|
{
|
|
18336
|
-
"
|
|
18337
|
-
"
|
|
18338
|
-
|
|
18339
|
-
|
|
18340
|
-
|
|
18341
|
-
|
|
18361
|
+
"kind": "method",
|
|
18362
|
+
"name": "renderError",
|
|
18363
|
+
"privacy": "protected",
|
|
18364
|
+
"inheritedFrom": {
|
|
18365
|
+
"name": "FormAssociatedMixin",
|
|
18366
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18367
|
+
}
|
|
18368
|
+
},
|
|
18369
|
+
{
|
|
18370
|
+
"kind": "method",
|
|
18371
|
+
"name": "getDescribedBy",
|
|
18372
|
+
"privacy": "protected",
|
|
18342
18373
|
"inheritedFrom": {
|
|
18343
18374
|
"name": "FormAssociatedMixin",
|
|
18344
18375
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18345
18376
|
}
|
|
18346
18377
|
},
|
|
18347
18378
|
{
|
|
18348
|
-
"
|
|
18349
|
-
"
|
|
18350
|
-
|
|
18351
|
-
},
|
|
18352
|
-
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
18353
|
-
"fieldName": "error",
|
|
18379
|
+
"kind": "method",
|
|
18380
|
+
"name": "getInvalid",
|
|
18381
|
+
"privacy": "protected",
|
|
18354
18382
|
"inheritedFrom": {
|
|
18355
18383
|
"name": "FormAssociatedMixin",
|
|
18356
18384
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18357
18385
|
}
|
|
18358
18386
|
},
|
|
18359
18387
|
{
|
|
18360
|
-
"
|
|
18361
|
-
"
|
|
18362
|
-
|
|
18363
|
-
|
|
18364
|
-
"default": "false",
|
|
18365
|
-
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
18366
|
-
"fieldName": "required",
|
|
18388
|
+
"kind": "field",
|
|
18389
|
+
"name": "hasHint",
|
|
18390
|
+
"privacy": "protected",
|
|
18391
|
+
"readonly": true,
|
|
18367
18392
|
"inheritedFrom": {
|
|
18368
18393
|
"name": "FormAssociatedMixin",
|
|
18369
18394
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18370
18395
|
}
|
|
18371
18396
|
},
|
|
18372
18397
|
{
|
|
18373
|
-
"
|
|
18374
|
-
"
|
|
18375
|
-
|
|
18376
|
-
|
|
18377
|
-
"default": "false",
|
|
18378
|
-
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
18379
|
-
"fieldName": "hideRequired",
|
|
18398
|
+
"kind": "field",
|
|
18399
|
+
"name": "hasError",
|
|
18400
|
+
"privacy": "protected",
|
|
18401
|
+
"readonly": true,
|
|
18380
18402
|
"inheritedFrom": {
|
|
18381
18403
|
"name": "FormAssociatedMixin",
|
|
18382
18404
|
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18383
18405
|
}
|
|
18384
18406
|
},
|
|
18385
18407
|
{
|
|
18408
|
+
"kind": "field",
|
|
18386
18409
|
"name": "disabled",
|
|
18387
18410
|
"type": {
|
|
18388
18411
|
"text": "boolean"
|
|
18389
18412
|
},
|
|
18390
18413
|
"default": "false",
|
|
18391
18414
|
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
18392
|
-
"
|
|
18415
|
+
"attribute": "disabled",
|
|
18416
|
+
"reflects": true,
|
|
18393
18417
|
"inheritedFrom": {
|
|
18394
18418
|
"name": "InputMixin",
|
|
18395
18419
|
"module": "src/common/mixins/InputMixin.ts"
|
|
18396
18420
|
}
|
|
18397
18421
|
},
|
|
18398
18422
|
{
|
|
18423
|
+
"kind": "field",
|
|
18399
18424
|
"name": "name",
|
|
18400
18425
|
"type": {
|
|
18401
18426
|
"text": "string | undefined"
|
|
18402
18427
|
},
|
|
18403
18428
|
"description": "The name of the form component.",
|
|
18404
|
-
"
|
|
18429
|
+
"attribute": "name",
|
|
18430
|
+
"reflects": true,
|
|
18405
18431
|
"inheritedFrom": {
|
|
18406
18432
|
"name": "InputMixin",
|
|
18407
18433
|
"module": "src/common/mixins/InputMixin.ts"
|
|
18408
18434
|
}
|
|
18409
18435
|
},
|
|
18410
18436
|
{
|
|
18437
|
+
"kind": "field",
|
|
18411
18438
|
"name": "value",
|
|
18412
18439
|
"type": {
|
|
18413
18440
|
"text": "string"
|
|
18414
18441
|
},
|
|
18415
18442
|
"default": "''",
|
|
18416
18443
|
"description": "The value of the form component.",
|
|
18417
|
-
"
|
|
18444
|
+
"attribute": "value",
|
|
18418
18445
|
"inheritedFrom": {
|
|
18419
18446
|
"name": "InputMixin",
|
|
18420
18447
|
"module": "src/common/mixins/InputMixin.ts"
|
|
18421
18448
|
}
|
|
18422
18449
|
},
|
|
18423
18450
|
{
|
|
18424
|
-
"
|
|
18451
|
+
"kind": "field",
|
|
18452
|
+
"name": "formAncestor",
|
|
18425
18453
|
"type": {
|
|
18426
18454
|
"text": "HTMLFormElement | null"
|
|
18427
18455
|
},
|
|
18428
|
-
"
|
|
18429
|
-
"
|
|
18456
|
+
"privacy": "private",
|
|
18457
|
+
"default": "null",
|
|
18430
18458
|
"inheritedFrom": {
|
|
18431
18459
|
"name": "InputMixin",
|
|
18432
18460
|
"module": "src/common/mixins/InputMixin.ts"
|
|
18433
18461
|
}
|
|
18434
|
-
}
|
|
18435
|
-
],
|
|
18436
|
-
"mixins": [
|
|
18437
|
-
{
|
|
18438
|
-
"name": "FormAssociatedMixin",
|
|
18439
|
-
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
18440
|
-
},
|
|
18441
|
-
{
|
|
18442
|
-
"name": "InputMixin",
|
|
18443
|
-
"module": "/src/common/mixins/InputMixin.js"
|
|
18444
18462
|
},
|
|
18445
18463
|
{
|
|
18446
|
-
"
|
|
18447
|
-
"
|
|
18448
|
-
}
|
|
18449
|
-
],
|
|
18450
|
-
"superclass": {
|
|
18451
|
-
"name": "LitElement",
|
|
18452
|
-
"package": "lit"
|
|
18453
|
-
},
|
|
18454
|
-
"localization": [],
|
|
18455
|
-
"status": "ready",
|
|
18456
|
-
"category": "form",
|
|
18457
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use toggles when your intent is to turn something on or off instantly.\n- Use for any feature or option that can be turned on or off.\n- If a physical switch would work for the action, the toggle is probably the best component to use.\n- Use for making it possible to choose one or more options from a limited number of options.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Toggles should never require users to click a button to apply or save the setting.\n- Avoid using when you have more than 10 options to choose from.\n- Don’t change the selection of another toggle when another one is clicked. Only exception is when a toggle is used to make a bulk selection of multiple items.\n\n</div>\n\n---\n\n## Content guidelines\n\nToggle labels should be clear, accurate and predictable. It should be possible for the user to understand what they are selecting:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing toggle labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">User Settings</div>\n\nAvoid ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Show dashboard</div>\n<div class=\"n-usage n-usage-dont\">Show dashboard.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients;</div>\n",
|
|
18458
|
-
"examples": [],
|
|
18459
|
-
"dependencies": [],
|
|
18460
|
-
"tagName": "nord-toggle",
|
|
18461
|
-
"customElement": true,
|
|
18462
|
-
"events": [
|
|
18463
|
-
{
|
|
18464
|
-
"name": "input",
|
|
18464
|
+
"kind": "field",
|
|
18465
|
+
"name": "_formId",
|
|
18465
18466
|
"type": {
|
|
18466
|
-
"text": "
|
|
18467
|
+
"text": "string | undefined"
|
|
18467
18468
|
},
|
|
18468
|
-
"
|
|
18469
|
+
"privacy": "protected",
|
|
18469
18470
|
"inheritedFrom": {
|
|
18470
|
-
"name": "
|
|
18471
|
-
"module": "src/common/mixins/
|
|
18471
|
+
"name": "InputMixin",
|
|
18472
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18472
18473
|
}
|
|
18473
18474
|
},
|
|
18474
18475
|
{
|
|
18475
|
-
"
|
|
18476
|
+
"kind": "field",
|
|
18477
|
+
"name": "form",
|
|
18476
18478
|
"type": {
|
|
18477
|
-
"text": "
|
|
18479
|
+
"text": "HTMLFormElement | null"
|
|
18478
18480
|
},
|
|
18479
|
-
"description": "
|
|
18481
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
18482
|
+
"attribute": "form",
|
|
18480
18483
|
"inheritedFrom": {
|
|
18481
|
-
"name": "
|
|
18482
|
-
"module": "src/common/mixins/
|
|
18484
|
+
"name": "InputMixin",
|
|
18485
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18483
18486
|
}
|
|
18484
|
-
}
|
|
18485
|
-
]
|
|
18486
|
-
}
|
|
18487
|
-
],
|
|
18488
|
-
"exports": [
|
|
18489
|
-
{
|
|
18490
|
-
"kind": "js",
|
|
18491
|
-
"name": "default",
|
|
18492
|
-
"declaration": {
|
|
18493
|
-
"name": "Toggle",
|
|
18494
|
-
"module": "src/toggle/Toggle.ts"
|
|
18495
|
-
}
|
|
18496
|
-
},
|
|
18497
|
-
{
|
|
18498
|
-
"kind": "custom-element-definition",
|
|
18499
|
-
"name": "nord-toggle",
|
|
18500
|
-
"declaration": {
|
|
18501
|
-
"name": "Toggle",
|
|
18502
|
-
"module": "src/toggle/Toggle.ts"
|
|
18503
|
-
}
|
|
18504
|
-
}
|
|
18505
|
-
]
|
|
18506
|
-
},
|
|
18507
|
-
{
|
|
18508
|
-
"kind": "javascript-module",
|
|
18509
|
-
"path": "src/tooltip/Tooltip.ts",
|
|
18510
|
-
"declarations": [
|
|
18511
|
-
{
|
|
18512
|
-
"kind": "class",
|
|
18513
|
-
"description": "Tooltips are floating containers for displaying additional information\nfor the currently focused element. A tooltip can be useful when you want\nto e.g. give a hint about an existing Command Menu shortcut.",
|
|
18514
|
-
"name": "Tooltip",
|
|
18515
|
-
"cssProperties": [
|
|
18516
|
-
{
|
|
18517
|
-
"description": "Controls the maximum inline size, or width, of the tooltip.",
|
|
18518
|
-
"name": "--n-tooltip-max-size",
|
|
18519
|
-
"default": "50ch"
|
|
18520
|
-
}
|
|
18521
|
-
],
|
|
18522
|
-
"slots": [
|
|
18523
|
-
{
|
|
18524
|
-
"description": "The tooltip content",
|
|
18525
|
-
"name": ""
|
|
18526
|
-
},
|
|
18527
|
-
{
|
|
18528
|
-
"description": "Optional slot that holds shortcut keys to access the subject",
|
|
18529
|
-
"name": "shortcut"
|
|
18530
|
-
}
|
|
18531
|
-
],
|
|
18532
|
-
"members": [
|
|
18533
|
-
{
|
|
18534
|
-
"kind": "field",
|
|
18535
|
-
"name": "lastOpened",
|
|
18536
|
-
"type": {
|
|
18537
|
-
"text": "Tooltip | undefined"
|
|
18538
|
-
},
|
|
18539
|
-
"privacy": "private",
|
|
18540
|
-
"static": true
|
|
18541
|
-
},
|
|
18542
|
-
{
|
|
18543
|
-
"kind": "field",
|
|
18544
|
-
"name": "shortcutSlot",
|
|
18545
|
-
"privacy": "private",
|
|
18546
|
-
"default": "new SlotController(this, 'shortcut')"
|
|
18547
18487
|
},
|
|
18548
18488
|
{
|
|
18549
18489
|
"kind": "field",
|
|
18550
|
-
"name": "
|
|
18551
|
-
"privacy": "
|
|
18552
|
-
"
|
|
18553
|
-
|
|
18554
|
-
|
|
18555
|
-
|
|
18556
|
-
"name": "currentElement",
|
|
18557
|
-
"type": {
|
|
18558
|
-
"text": "FocusableElement | undefined"
|
|
18559
|
-
},
|
|
18560
|
-
"privacy": "private"
|
|
18490
|
+
"name": "focusableRef",
|
|
18491
|
+
"privacy": "protected",
|
|
18492
|
+
"inheritedFrom": {
|
|
18493
|
+
"name": "FocusableMixin",
|
|
18494
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18495
|
+
}
|
|
18561
18496
|
},
|
|
18562
18497
|
{
|
|
18563
|
-
"kind": "
|
|
18564
|
-
"name": "
|
|
18565
|
-
"
|
|
18566
|
-
|
|
18567
|
-
|
|
18568
|
-
|
|
18498
|
+
"kind": "method",
|
|
18499
|
+
"name": "focus",
|
|
18500
|
+
"parameters": [
|
|
18501
|
+
{
|
|
18502
|
+
"name": "options",
|
|
18503
|
+
"optional": true,
|
|
18504
|
+
"type": {
|
|
18505
|
+
"text": "FocusOptions"
|
|
18506
|
+
},
|
|
18507
|
+
"description": "An object which controls aspects of the focusing process."
|
|
18508
|
+
}
|
|
18509
|
+
],
|
|
18510
|
+
"description": "Programmatically move focus to the component.",
|
|
18511
|
+
"inheritedFrom": {
|
|
18512
|
+
"name": "FocusableMixin",
|
|
18513
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18514
|
+
}
|
|
18569
18515
|
},
|
|
18570
18516
|
{
|
|
18571
|
-
"kind": "
|
|
18572
|
-
"name": "
|
|
18573
|
-
"
|
|
18574
|
-
|
|
18575
|
-
|
|
18576
|
-
|
|
18577
|
-
|
|
18517
|
+
"kind": "method",
|
|
18518
|
+
"name": "blur",
|
|
18519
|
+
"description": "Programmatically remove focus from the component.",
|
|
18520
|
+
"inheritedFrom": {
|
|
18521
|
+
"name": "FocusableMixin",
|
|
18522
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18523
|
+
}
|
|
18578
18524
|
},
|
|
18579
18525
|
{
|
|
18580
|
-
"kind": "
|
|
18581
|
-
"name": "
|
|
18582
|
-
"
|
|
18583
|
-
|
|
18584
|
-
|
|
18585
|
-
|
|
18586
|
-
|
|
18587
|
-
|
|
18588
|
-
|
|
18526
|
+
"kind": "method",
|
|
18527
|
+
"name": "click",
|
|
18528
|
+
"description": "Programmatically simulates a click on the component.",
|
|
18529
|
+
"inheritedFrom": {
|
|
18530
|
+
"name": "FocusableMixin",
|
|
18531
|
+
"module": "src/common/mixins/FocusableMixin.ts"
|
|
18532
|
+
}
|
|
18533
|
+
}
|
|
18534
|
+
],
|
|
18535
|
+
"attributes": [
|
|
18589
18536
|
{
|
|
18590
|
-
"
|
|
18591
|
-
"name": "coords",
|
|
18537
|
+
"name": "checked",
|
|
18592
18538
|
"type": {
|
|
18593
|
-
"text": "
|
|
18539
|
+
"text": "boolean"
|
|
18594
18540
|
},
|
|
18595
|
-
"
|
|
18596
|
-
"
|
|
18541
|
+
"default": "false",
|
|
18542
|
+
"description": "Controls whether the toggle is checked or not.",
|
|
18543
|
+
"fieldName": "checked"
|
|
18597
18544
|
},
|
|
18598
18545
|
{
|
|
18599
|
-
"
|
|
18600
|
-
"name": "position",
|
|
18546
|
+
"name": "reverse",
|
|
18601
18547
|
"type": {
|
|
18602
|
-
"text": "
|
|
18548
|
+
"text": "boolean"
|
|
18603
18549
|
},
|
|
18604
|
-
"default": "
|
|
18605
|
-
"description": "
|
|
18606
|
-
"
|
|
18607
|
-
"reflects": true
|
|
18550
|
+
"default": "false",
|
|
18551
|
+
"description": "Controls whether the contents are displayed in reverse order,\nputting the label before the toggle.",
|
|
18552
|
+
"fieldName": "reverse"
|
|
18608
18553
|
},
|
|
18609
18554
|
{
|
|
18610
|
-
"
|
|
18611
|
-
"name": "role",
|
|
18555
|
+
"name": "size",
|
|
18612
18556
|
"type": {
|
|
18613
|
-
"text": "
|
|
18557
|
+
"text": "'s' | 'm' | 'l'"
|
|
18614
18558
|
},
|
|
18615
|
-
"default": "'
|
|
18616
|
-
"description": "The
|
|
18617
|
-
"
|
|
18618
|
-
"reflects": true
|
|
18559
|
+
"default": "'m'",
|
|
18560
|
+
"description": "The size of the toggle switch.",
|
|
18561
|
+
"fieldName": "size"
|
|
18619
18562
|
},
|
|
18620
18563
|
{
|
|
18621
|
-
"
|
|
18622
|
-
"name": "id",
|
|
18564
|
+
"name": "label",
|
|
18623
18565
|
"type": {
|
|
18624
18566
|
"text": "string"
|
|
18625
18567
|
},
|
|
18626
18568
|
"default": "''",
|
|
18627
|
-
"description": "
|
|
18628
|
-
"
|
|
18629
|
-
"
|
|
18569
|
+
"description": "Label for the input.",
|
|
18570
|
+
"fieldName": "label",
|
|
18571
|
+
"inheritedFrom": {
|
|
18572
|
+
"name": "FormAssociatedMixin",
|
|
18573
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18574
|
+
}
|
|
18630
18575
|
},
|
|
18631
18576
|
{
|
|
18632
|
-
"
|
|
18633
|
-
"name": "delay",
|
|
18577
|
+
"name": "hint",
|
|
18634
18578
|
"type": {
|
|
18635
|
-
"text": "
|
|
18579
|
+
"text": "string | undefined"
|
|
18636
18580
|
},
|
|
18637
|
-
"
|
|
18638
|
-
"
|
|
18639
|
-
"
|
|
18640
|
-
|
|
18641
|
-
|
|
18642
|
-
|
|
18643
|
-
"kind": "method",
|
|
18644
|
-
"name": "handleIdChange",
|
|
18645
|
-
"privacy": "protected"
|
|
18646
|
-
},
|
|
18647
|
-
{
|
|
18648
|
-
"kind": "method",
|
|
18649
|
-
"name": "handleStateChange",
|
|
18650
|
-
"privacy": "private",
|
|
18651
|
-
"parameters": [
|
|
18652
|
-
{
|
|
18653
|
-
"name": "prevState",
|
|
18654
|
-
"type": {
|
|
18655
|
-
"text": "TooltipStates"
|
|
18656
|
-
}
|
|
18657
|
-
}
|
|
18658
|
-
]
|
|
18659
|
-
},
|
|
18660
|
-
{
|
|
18661
|
-
"kind": "field",
|
|
18662
|
-
"name": "updatePosition",
|
|
18663
|
-
"privacy": "private",
|
|
18664
|
-
"description": "Setting and updating the position of the tooltip"
|
|
18665
|
-
},
|
|
18666
|
-
{
|
|
18667
|
-
"kind": "field",
|
|
18668
|
-
"name": "hideTooltip",
|
|
18669
|
-
"privacy": "private"
|
|
18581
|
+
"description": "Optional hint text to be displayed with the input. Alternatively use the hint slot.",
|
|
18582
|
+
"fieldName": "hint",
|
|
18583
|
+
"inheritedFrom": {
|
|
18584
|
+
"name": "FormAssociatedMixin",
|
|
18585
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18586
|
+
}
|
|
18670
18587
|
},
|
|
18671
18588
|
{
|
|
18672
|
-
"
|
|
18673
|
-
"
|
|
18674
|
-
|
|
18589
|
+
"name": "hide-label",
|
|
18590
|
+
"type": {
|
|
18591
|
+
"text": "boolean"
|
|
18592
|
+
},
|
|
18593
|
+
"default": "false",
|
|
18594
|
+
"description": "Visually hide the label, but still show it to assistive technologies like screen readers.",
|
|
18595
|
+
"fieldName": "hideLabel",
|
|
18596
|
+
"inheritedFrom": {
|
|
18597
|
+
"name": "FormAssociatedMixin",
|
|
18598
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18599
|
+
}
|
|
18675
18600
|
},
|
|
18676
18601
|
{
|
|
18677
|
-
"
|
|
18678
|
-
"
|
|
18679
|
-
|
|
18602
|
+
"name": "placeholder",
|
|
18603
|
+
"type": {
|
|
18604
|
+
"text": "string | undefined"
|
|
18605
|
+
},
|
|
18606
|
+
"description": "Placeholder text to display within the input.",
|
|
18607
|
+
"fieldName": "placeholder",
|
|
18608
|
+
"inheritedFrom": {
|
|
18609
|
+
"name": "FormAssociatedMixin",
|
|
18610
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18611
|
+
}
|
|
18680
18612
|
},
|
|
18681
18613
|
{
|
|
18682
|
-
"
|
|
18683
|
-
"
|
|
18684
|
-
|
|
18614
|
+
"name": "error",
|
|
18615
|
+
"type": {
|
|
18616
|
+
"text": "string | undefined"
|
|
18617
|
+
},
|
|
18618
|
+
"description": "Optional error to be shown with the input. Alternatively use the error slot.",
|
|
18619
|
+
"fieldName": "error",
|
|
18620
|
+
"inheritedFrom": {
|
|
18621
|
+
"name": "FormAssociatedMixin",
|
|
18622
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18623
|
+
}
|
|
18685
18624
|
},
|
|
18686
18625
|
{
|
|
18687
|
-
"
|
|
18688
|
-
"
|
|
18689
|
-
|
|
18626
|
+
"name": "required",
|
|
18627
|
+
"type": {
|
|
18628
|
+
"text": "boolean"
|
|
18629
|
+
},
|
|
18630
|
+
"default": "false",
|
|
18631
|
+
"description": "Determines whether the input is required or not.\nAn input marked as required will be announced as such to users of assistive technology.\nWhen using this property you need to also set “novalidate” attribute on a form element to prevent browser from displaying its own validation errors.",
|
|
18632
|
+
"fieldName": "required",
|
|
18633
|
+
"inheritedFrom": {
|
|
18634
|
+
"name": "FormAssociatedMixin",
|
|
18635
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18636
|
+
}
|
|
18690
18637
|
},
|
|
18691
18638
|
{
|
|
18692
|
-
"
|
|
18693
|
-
"
|
|
18694
|
-
|
|
18639
|
+
"name": "hide-required",
|
|
18640
|
+
"type": {
|
|
18641
|
+
"text": "boolean"
|
|
18642
|
+
},
|
|
18643
|
+
"default": "false",
|
|
18644
|
+
"description": "Visually hide the required indicator, but still show\nrequired attribute to assistive technologies like screen readers.",
|
|
18645
|
+
"fieldName": "hideRequired",
|
|
18646
|
+
"inheritedFrom": {
|
|
18647
|
+
"name": "FormAssociatedMixin",
|
|
18648
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18649
|
+
}
|
|
18695
18650
|
},
|
|
18696
18651
|
{
|
|
18697
|
-
"
|
|
18698
|
-
"name": "removeDescribedBy",
|
|
18699
|
-
"privacy": "private"
|
|
18700
|
-
}
|
|
18701
|
-
],
|
|
18702
|
-
"attributes": [
|
|
18703
|
-
{
|
|
18704
|
-
"name": "position",
|
|
18652
|
+
"name": "disabled",
|
|
18705
18653
|
"type": {
|
|
18706
|
-
"text": "
|
|
18654
|
+
"text": "boolean"
|
|
18707
18655
|
},
|
|
18708
|
-
"default": "
|
|
18709
|
-
"description": "
|
|
18710
|
-
"fieldName": "
|
|
18656
|
+
"default": "false",
|
|
18657
|
+
"description": "Makes the component disabled. This prevents users from\nbeing able to interact with the component, and conveys\nits inactive state to assistive technologies.",
|
|
18658
|
+
"fieldName": "disabled",
|
|
18659
|
+
"inheritedFrom": {
|
|
18660
|
+
"name": "InputMixin",
|
|
18661
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18662
|
+
}
|
|
18711
18663
|
},
|
|
18712
18664
|
{
|
|
18713
|
-
"name": "
|
|
18665
|
+
"name": "name",
|
|
18714
18666
|
"type": {
|
|
18715
|
-
"text": "string"
|
|
18667
|
+
"text": "string | undefined"
|
|
18716
18668
|
},
|
|
18717
|
-
"
|
|
18718
|
-
"
|
|
18719
|
-
"
|
|
18669
|
+
"description": "The name of the form component.",
|
|
18670
|
+
"fieldName": "name",
|
|
18671
|
+
"inheritedFrom": {
|
|
18672
|
+
"name": "InputMixin",
|
|
18673
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18674
|
+
}
|
|
18720
18675
|
},
|
|
18721
18676
|
{
|
|
18722
|
-
"name": "
|
|
18677
|
+
"name": "value",
|
|
18723
18678
|
"type": {
|
|
18724
18679
|
"text": "string"
|
|
18725
18680
|
},
|
|
18726
18681
|
"default": "''",
|
|
18727
|
-
"description": "The
|
|
18728
|
-
"fieldName": "
|
|
18682
|
+
"description": "The value of the form component.",
|
|
18683
|
+
"fieldName": "value",
|
|
18684
|
+
"inheritedFrom": {
|
|
18685
|
+
"name": "InputMixin",
|
|
18686
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18687
|
+
}
|
|
18729
18688
|
},
|
|
18730
18689
|
{
|
|
18731
|
-
"name": "
|
|
18690
|
+
"name": "form",
|
|
18732
18691
|
"type": {
|
|
18733
|
-
"text": "
|
|
18692
|
+
"text": "HTMLFormElement | null"
|
|
18734
18693
|
},
|
|
18735
|
-
"
|
|
18736
|
-
"
|
|
18737
|
-
"
|
|
18694
|
+
"description": "Gets the form, if any, associated with the form element.\nThe setter accepts a string, which is the id of the form.",
|
|
18695
|
+
"fieldName": "form",
|
|
18696
|
+
"inheritedFrom": {
|
|
18697
|
+
"name": "InputMixin",
|
|
18698
|
+
"module": "src/common/mixins/InputMixin.ts"
|
|
18699
|
+
}
|
|
18700
|
+
}
|
|
18701
|
+
],
|
|
18702
|
+
"mixins": [
|
|
18703
|
+
{
|
|
18704
|
+
"name": "FormAssociatedMixin",
|
|
18705
|
+
"module": "/src/common/mixins/FormAssociatedMixin.js"
|
|
18706
|
+
},
|
|
18707
|
+
{
|
|
18708
|
+
"name": "InputMixin",
|
|
18709
|
+
"module": "/src/common/mixins/InputMixin.js"
|
|
18710
|
+
},
|
|
18711
|
+
{
|
|
18712
|
+
"name": "FocusableMixin",
|
|
18713
|
+
"module": "/src/common/mixins/FocusableMixin.js"
|
|
18738
18714
|
}
|
|
18739
18715
|
],
|
|
18740
18716
|
"superclass": {
|
|
@@ -18743,12 +18719,36 @@
|
|
|
18743
18719
|
},
|
|
18744
18720
|
"localization": [],
|
|
18745
18721
|
"status": "ready",
|
|
18746
|
-
"category": "
|
|
18747
|
-
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use
|
|
18722
|
+
"category": "form",
|
|
18723
|
+
"readme": "## Usage\n\nThis section includes guidelines for designers and developers about the usage of this component in different contexts.\n\n<div class=\"n-usage n-usage-do\">\n\n### Do\n\n- Use toggles when your intent is to turn something on or off instantly.\n- Use for any feature or option that can be turned on or off.\n- If a physical switch would work for the action, the toggle is probably the best component to use.\n- Use for making it possible to choose one or more options from a limited number of options.\n\n</div>\n<div class=\"n-usage n-usage-dont\">\n\n### Don’t\n\n- Toggles should never require users to click a button to apply or save the setting.\n- Avoid using when you have more than 10 options to choose from.\n- Don’t change the selection of another toggle when another one is clicked. Only exception is when a toggle is used to make a bulk selection of multiple items.\n\n</div>\n\n---\n\n## Content guidelines\n\nToggle labels should be clear, accurate and predictable. It should be possible for the user to understand what they are selecting:\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">Option 1</div>\n\nWhen writing toggle labels, always write them in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):\n\n<div class=\"n-usage n-usage-do\">User settings</div>\n<div class=\"n-usage n-usage-dont\">User Settings</div>\n\nAvoid ending in punctuation if it’s a single sentence, word, or a fragment:\n\n<div class=\"n-usage n-usage-do\">Show dashboard</div>\n<div class=\"n-usage n-usage-dont\">Show dashboard.</div>\n\nDo not use commas or semicolons at the end of each line\n\n<div class=\"n-usage n-usage-do\">Patients</div>\n<div class=\"n-usage n-usage-dont\">Patients;</div>\n",
|
|
18748
18724
|
"examples": [],
|
|
18749
18725
|
"dependencies": [],
|
|
18750
|
-
"tagName": "nord-
|
|
18751
|
-
"customElement": true
|
|
18726
|
+
"tagName": "nord-toggle",
|
|
18727
|
+
"customElement": true,
|
|
18728
|
+
"events": [
|
|
18729
|
+
{
|
|
18730
|
+
"name": "input",
|
|
18731
|
+
"type": {
|
|
18732
|
+
"text": "NordEvent"
|
|
18733
|
+
},
|
|
18734
|
+
"description": "Fired as the user types into the input.",
|
|
18735
|
+
"inheritedFrom": {
|
|
18736
|
+
"name": "FormAssociatedMixin",
|
|
18737
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18738
|
+
}
|
|
18739
|
+
},
|
|
18740
|
+
{
|
|
18741
|
+
"name": "change",
|
|
18742
|
+
"type": {
|
|
18743
|
+
"text": "NordEvent"
|
|
18744
|
+
},
|
|
18745
|
+
"description": "Fired whenever the input's value is changed via user interaction.",
|
|
18746
|
+
"inheritedFrom": {
|
|
18747
|
+
"name": "FormAssociatedMixin",
|
|
18748
|
+
"module": "src/common/mixins/FormAssociatedMixin.ts"
|
|
18749
|
+
}
|
|
18750
|
+
}
|
|
18751
|
+
]
|
|
18752
18752
|
}
|
|
18753
18753
|
],
|
|
18754
18754
|
"exports": [
|
|
@@ -18756,16 +18756,16 @@
|
|
|
18756
18756
|
"kind": "js",
|
|
18757
18757
|
"name": "default",
|
|
18758
18758
|
"declaration": {
|
|
18759
|
-
"name": "
|
|
18760
|
-
"module": "src/
|
|
18759
|
+
"name": "Toggle",
|
|
18760
|
+
"module": "src/toggle/Toggle.ts"
|
|
18761
18761
|
}
|
|
18762
18762
|
},
|
|
18763
18763
|
{
|
|
18764
18764
|
"kind": "custom-element-definition",
|
|
18765
|
-
"name": "nord-
|
|
18765
|
+
"name": "nord-toggle",
|
|
18766
18766
|
"declaration": {
|
|
18767
|
-
"name": "
|
|
18768
|
-
"module": "src/
|
|
18767
|
+
"name": "Toggle",
|
|
18768
|
+
"module": "src/toggle/Toggle.ts"
|
|
18769
18769
|
}
|
|
18770
18770
|
}
|
|
18771
18771
|
]
|