@ukic/docs 2.1.0-beta.11 → 2.1.0-beta.12

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.
Files changed (2) hide show
  1. package/docs.json +190 -9
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2023-04-12T14:40:39",
2
+ "timestamp": "2023-05-03T10:24:19",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "2.20.0",
@@ -508,6 +508,102 @@
508
508
  "optional": true,
509
509
  "required": false
510
510
  },
511
+ {
512
+ "name": "form",
513
+ "type": "string",
514
+ "mutable": false,
515
+ "attr": "form",
516
+ "reflectToAttr": false,
517
+ "docs": "The <form> element to associate the button with.",
518
+ "docsTags": [],
519
+ "values": [
520
+ {
521
+ "type": "string"
522
+ }
523
+ ],
524
+ "optional": true,
525
+ "required": false
526
+ },
527
+ {
528
+ "name": "formaction",
529
+ "type": "string",
530
+ "mutable": false,
531
+ "attr": "formaction",
532
+ "reflectToAttr": false,
533
+ "docs": "The URL that processes the information submitted by the button. It overrides the action attribute of the button's form owner. Does nothing if there is no form owner.",
534
+ "docsTags": [],
535
+ "values": [
536
+ {
537
+ "type": "string"
538
+ }
539
+ ],
540
+ "optional": true,
541
+ "required": false
542
+ },
543
+ {
544
+ "name": "formenctype",
545
+ "type": "string",
546
+ "mutable": false,
547
+ "attr": "formenctype",
548
+ "reflectToAttr": false,
549
+ "docs": "The way the submitted form data is encoded.",
550
+ "docsTags": [],
551
+ "values": [
552
+ {
553
+ "type": "string"
554
+ }
555
+ ],
556
+ "optional": true,
557
+ "required": false
558
+ },
559
+ {
560
+ "name": "formmethod",
561
+ "type": "string",
562
+ "mutable": false,
563
+ "attr": "formmethod",
564
+ "reflectToAttr": false,
565
+ "docs": "The HTTP method used to submit the form.",
566
+ "docsTags": [],
567
+ "values": [
568
+ {
569
+ "type": "string"
570
+ }
571
+ ],
572
+ "optional": true,
573
+ "required": false
574
+ },
575
+ {
576
+ "name": "formnovalidate",
577
+ "type": "boolean",
578
+ "mutable": false,
579
+ "attr": "formnovalidate",
580
+ "reflectToAttr": false,
581
+ "docs": "If `true`, the form will not be validated when submitted.",
582
+ "docsTags": [],
583
+ "values": [
584
+ {
585
+ "type": "boolean"
586
+ }
587
+ ],
588
+ "optional": true,
589
+ "required": false
590
+ },
591
+ {
592
+ "name": "formtarget",
593
+ "type": "string",
594
+ "mutable": false,
595
+ "attr": "formtarget",
596
+ "reflectToAttr": false,
597
+ "docs": "The place to display the response from submitting the form. It overrides the target attribute of the button's form owner.",
598
+ "docsTags": [],
599
+ "values": [
600
+ {
601
+ "type": "string"
602
+ }
603
+ ],
604
+ "optional": true,
605
+ "required": false
606
+ },
511
607
  {
512
608
  "name": "fullWidth",
513
609
  "type": "boolean",
@@ -1409,6 +1505,23 @@
1409
1505
  "optional": false,
1410
1506
  "required": false
1411
1507
  },
1508
+ {
1509
+ "name": "small",
1510
+ "type": "boolean",
1511
+ "mutable": false,
1512
+ "attr": "small",
1513
+ "reflectToAttr": false,
1514
+ "docs": "If true, the small styling will be applied to the checkbox.",
1515
+ "docsTags": [],
1516
+ "default": "false",
1517
+ "values": [
1518
+ {
1519
+ "type": "boolean"
1520
+ }
1521
+ ],
1522
+ "optional": true,
1523
+ "required": false
1524
+ },
1412
1525
  {
1413
1526
  "name": "value",
1414
1527
  "type": "string",
@@ -8495,6 +8608,16 @@
8495
8608
  "event": "tabClick",
8496
8609
  "capture": false,
8497
8610
  "passive": false
8611
+ },
8612
+ {
8613
+ "event": "tabCreated",
8614
+ "capture": false,
8615
+ "passive": false
8616
+ },
8617
+ {
8618
+ "event": "tabPanelCreated",
8619
+ "capture": false,
8620
+ "passive": false
8498
8621
  }
8499
8622
  ],
8500
8623
  "styles": [],
@@ -8519,9 +8642,15 @@
8519
8642
  "mutable": false,
8520
8643
  "attr": "context-id",
8521
8644
  "reflectToAttr": true,
8522
- "docs": "The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.",
8523
- "docsTags": [],
8645
+ "docs": "",
8646
+ "docsTags": [
8647
+ {
8648
+ "name": "deprecated",
8649
+ "text": "This is no longer required.\nThe context id is passed down from `ic-tab-context`"
8650
+ }
8651
+ ],
8524
8652
  "default": "\"default\"",
8653
+ "deprecation": "This is no longer required.\nThe context id is passed down from `ic-tab-context`",
8525
8654
  "values": [
8526
8655
  {
8527
8656
  "type": "string"
@@ -8608,9 +8737,15 @@
8608
8737
  "mutable": false,
8609
8738
  "attr": "context-id",
8610
8739
  "reflectToAttr": true,
8611
- "docs": "The unique context needed if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.",
8612
- "docsTags": [],
8740
+ "docs": "",
8741
+ "docsTags": [
8742
+ {
8743
+ "name": "deprecated",
8744
+ "text": "This is no longer required.\nThe context id is passed down from `ic-tab-context`"
8745
+ }
8746
+ ],
8613
8747
  "default": "\"default\"",
8748
+ "deprecation": "This is no longer required.\nThe context id is passed down from `ic-tab-context`",
8614
8749
  "values": [
8615
8750
  {
8616
8751
  "type": "string"
@@ -9094,6 +9229,23 @@
9094
9229
  "optional": false,
9095
9230
  "required": true
9096
9231
  },
9232
+ {
9233
+ "name": "max",
9234
+ "type": "number",
9235
+ "mutable": false,
9236
+ "attr": "max",
9237
+ "reflectToAttr": false,
9238
+ "docs": "The maximum number that can be accepted as a value, when `type` is `number` and `rows` is `1`. (NOTE: Ensure to include visual indication of max value in `helperText` or `label`)",
9239
+ "docsTags": [],
9240
+ "default": "undefined",
9241
+ "values": [
9242
+ {
9243
+ "type": "number"
9244
+ }
9245
+ ],
9246
+ "optional": false,
9247
+ "required": false
9248
+ },
9097
9249
  {
9098
9250
  "name": "maxLength",
9099
9251
  "type": "number",
@@ -9111,6 +9263,23 @@
9111
9263
  "optional": false,
9112
9264
  "required": false
9113
9265
  },
9266
+ {
9267
+ "name": "min",
9268
+ "type": "number",
9269
+ "mutable": false,
9270
+ "attr": "min",
9271
+ "reflectToAttr": false,
9272
+ "docs": "The minimum number that can be accepted as a value, when `type` is `number` and `rows` is `1`. (NOTE: Ensure to include visual indication of min value in `helperText` or `label`)",
9273
+ "docsTags": [],
9274
+ "default": "undefined",
9275
+ "values": [
9276
+ {
9277
+ "type": "number"
9278
+ }
9279
+ ],
9280
+ "optional": false,
9281
+ "required": false
9282
+ },
9114
9283
  {
9115
9284
  "name": "name",
9116
9285
  "type": "string",
@@ -9538,7 +9707,7 @@
9538
9707
  {
9539
9708
  "name": "autoDismissTimeout",
9540
9709
  "type": "number",
9541
- "mutable": false,
9710
+ "mutable": true,
9542
9711
  "attr": "auto-dismiss-timeout",
9543
9712
  "reflectToAttr": false,
9544
9713
  "docs": "If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)\n(NOTE: Has a minimum value of `5000ms`)",
@@ -9572,7 +9741,7 @@
9572
9741
  {
9573
9742
  "name": "dismissMode",
9574
9743
  "type": "\"automatic\" | \"manual\"",
9575
- "mutable": false,
9744
+ "mutable": true,
9576
9745
  "attr": "dismiss-mode",
9577
9746
  "reflectToAttr": false,
9578
9747
  "docs": "How the toast will be dismissed. If manual will display a dismiss button.",
@@ -9642,7 +9811,7 @@
9642
9811
  {
9643
9812
  "name": "variant",
9644
9813
  "type": "\"error\" | \"info\" | \"neutral\" | \"success\" | \"warning\"",
9645
- "mutable": false,
9814
+ "mutable": true,
9646
9815
  "attr": "variant",
9647
9816
  "reflectToAttr": false,
9648
9817
  "docs": "The variant of the toast being rendered",
@@ -10226,7 +10395,7 @@
10226
10395
  },
10227
10396
  {
10228
10397
  "name": "variant",
10229
- "type": "\"body\" | \"caption\" | \"caption-uppercase\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"label\" | \"label-uppercase\" | \"subtitle-large\" | \"subtitle-small\"",
10398
+ "type": "\"body\" | \"caption\" | \"caption-uppercase\" | \"code-extra-small\" | \"code-large\" | \"code-small\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"label\" | \"label-uppercase\" | \"subtitle-large\" | \"subtitle-small\"",
10230
10399
  "mutable": false,
10231
10400
  "attr": "variant",
10232
10401
  "reflectToAttr": false,
@@ -10246,6 +10415,18 @@
10246
10415
  "value": "caption-uppercase",
10247
10416
  "type": "string"
10248
10417
  },
10418
+ {
10419
+ "value": "code-extra-small",
10420
+ "type": "string"
10421
+ },
10422
+ {
10423
+ "value": "code-large",
10424
+ "type": "string"
10425
+ },
10426
+ {
10427
+ "value": "code-small",
10428
+ "type": "string"
10429
+ },
10249
10430
  {
10250
10431
  "value": "h1",
10251
10432
  "type": "string"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ukic/docs",
3
- "version": "2.1.0-beta.11",
3
+ "version": "2.1.0-beta.12",
4
4
  "description": "API documentation for @ukic components",
5
5
  "main": "docs.json",
6
6
  "types": "docs.d.ts",
@@ -9,5 +9,5 @@
9
9
  "docs.d.ts"
10
10
  ],
11
11
  "license": "MIT",
12
- "gitHead": "c2853b352452de9cf09157c2b704ec7466b34d4c"
12
+ "gitHead": "72bf817d43a6f91d56e03aa4d4252ca817285fca"
13
13
  }