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

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 +491 -7
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2023-03-28T06:43:19",
2
+ "timestamp": "2023-04-12T14:40:39",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "2.20.0",
@@ -829,6 +829,7 @@
829
829
  "ic-alert",
830
830
  "ic-card",
831
831
  "ic-horizontal-scroll",
832
+ "ic-menu-item",
832
833
  "ic-navigation-button",
833
834
  "ic-navigation-menu",
834
835
  "ic-search-bar",
@@ -861,6 +862,9 @@
861
862
  "ic-horizontal-scroll": [
862
863
  "ic-button"
863
864
  ],
865
+ "ic-menu-item": [
866
+ "ic-button"
867
+ ],
864
868
  "ic-navigation-button": [
865
869
  "ic-button"
866
870
  ],
@@ -3681,8 +3685,14 @@
3681
3685
  "mutable": false,
3682
3686
  "attr": "show-icon",
3683
3687
  "reflectToAttr": false,
3684
- "docs": "If `true`, the 'open in new tab/window' icon will be displayed.",
3685
- "docsTags": [],
3688
+ "docs": "",
3689
+ "docsTags": [
3690
+ {
3691
+ "name": "deprecated",
3692
+ "text": "This prop should not be used anymore. The 'open in new tab/window' icon will display automatically if target=\"_blank\"."
3693
+ }
3694
+ ],
3695
+ "deprecation": "This prop should not be used anymore. The 'open in new tab/window' icon will display automatically if target=\"_blank\".",
3686
3696
  "values": [
3687
3697
  {
3688
3698
  "type": "boolean"
@@ -3986,7 +3996,7 @@
3986
3996
  },
3987
3997
  {
3988
3998
  "filePath": "./src/components/ic-menu/ic-menu.tsx",
3989
- "encapsulation": "shadow",
3999
+ "encapsulation": "scoped",
3990
4000
  "tag": "ic-menu",
3991
4001
  "readme": "# ic-menu\n\n\n",
3992
4002
  "docs": "",
@@ -4207,6 +4217,326 @@
4207
4217
  ]
4208
4218
  }
4209
4219
  },
4220
+ {
4221
+ "filePath": "./src/components/ic-menu-group/ic-menu-group.tsx",
4222
+ "encapsulation": "shadow",
4223
+ "tag": "ic-menu-group",
4224
+ "readme": "# ic-menu-group\n\n\n",
4225
+ "docs": "",
4226
+ "docsTags": [],
4227
+ "usage": {},
4228
+ "props": [
4229
+ {
4230
+ "name": "label",
4231
+ "type": "string",
4232
+ "mutable": false,
4233
+ "attr": "label",
4234
+ "reflectToAttr": false,
4235
+ "docs": "The label to display as the title of the menu group.",
4236
+ "docsTags": [],
4237
+ "values": [
4238
+ {
4239
+ "type": "string"
4240
+ }
4241
+ ],
4242
+ "optional": true,
4243
+ "required": false
4244
+ }
4245
+ ],
4246
+ "methods": [],
4247
+ "events": [],
4248
+ "listeners": [],
4249
+ "styles": [],
4250
+ "slots": [],
4251
+ "parts": [],
4252
+ "dependents": [],
4253
+ "dependencies": [
4254
+ "ic-typography"
4255
+ ],
4256
+ "dependencyGraph": {
4257
+ "ic-menu-group": [
4258
+ "ic-typography"
4259
+ ]
4260
+ }
4261
+ },
4262
+ {
4263
+ "filePath": "./src/components/ic-menu-item/ic-menu-item.tsx",
4264
+ "encapsulation": "shadow",
4265
+ "tag": "ic-menu-item",
4266
+ "readme": "# ic-menu-item\n\n\n",
4267
+ "docs": "",
4268
+ "docsTags": [
4269
+ {
4270
+ "name": "slot",
4271
+ "text": "icon - Content will be placed to the left of the menu item label."
4272
+ }
4273
+ ],
4274
+ "usage": {},
4275
+ "props": [
4276
+ {
4277
+ "name": "description",
4278
+ "type": "string",
4279
+ "mutable": false,
4280
+ "attr": "description",
4281
+ "reflectToAttr": false,
4282
+ "docs": "The description displayed in the menu item, below the label.",
4283
+ "docsTags": [],
4284
+ "values": [
4285
+ {
4286
+ "type": "string"
4287
+ }
4288
+ ],
4289
+ "optional": true,
4290
+ "required": false
4291
+ },
4292
+ {
4293
+ "name": "disabled",
4294
+ "type": "boolean",
4295
+ "mutable": false,
4296
+ "attr": "disabled",
4297
+ "reflectToAttr": false,
4298
+ "docs": "If `true`, the menu item will be in disabled state.",
4299
+ "docsTags": [],
4300
+ "default": "false",
4301
+ "values": [
4302
+ {
4303
+ "type": "boolean"
4304
+ }
4305
+ ],
4306
+ "optional": true,
4307
+ "required": false
4308
+ },
4309
+ {
4310
+ "name": "href",
4311
+ "type": "string",
4312
+ "mutable": false,
4313
+ "attr": "href",
4314
+ "reflectToAttr": false,
4315
+ "docs": "The URL that the link points to. This will render the menu item as an \"a\" tag.",
4316
+ "docsTags": [],
4317
+ "values": [
4318
+ {
4319
+ "type": "string"
4320
+ }
4321
+ ],
4322
+ "optional": true,
4323
+ "required": false
4324
+ },
4325
+ {
4326
+ "name": "hreflang",
4327
+ "type": "string",
4328
+ "mutable": false,
4329
+ "attr": "hreflang",
4330
+ "reflectToAttr": false,
4331
+ "docs": "The human language of the linked URL.",
4332
+ "docsTags": [],
4333
+ "values": [
4334
+ {
4335
+ "type": "string"
4336
+ }
4337
+ ],
4338
+ "optional": true,
4339
+ "required": false
4340
+ },
4341
+ {
4342
+ "name": "keyboardShortcut",
4343
+ "type": "string",
4344
+ "mutable": false,
4345
+ "attr": "keyboard-shortcut",
4346
+ "reflectToAttr": false,
4347
+ "docs": "The label describing the keyboard shortcut for a menu item's action.",
4348
+ "docsTags": [],
4349
+ "values": [
4350
+ {
4351
+ "type": "string"
4352
+ }
4353
+ ],
4354
+ "optional": true,
4355
+ "required": false
4356
+ },
4357
+ {
4358
+ "name": "label",
4359
+ "type": "string",
4360
+ "mutable": false,
4361
+ "attr": "label",
4362
+ "reflectToAttr": false,
4363
+ "docs": "The label to display in the menu item.",
4364
+ "docsTags": [],
4365
+ "values": [
4366
+ {
4367
+ "type": "string"
4368
+ }
4369
+ ],
4370
+ "optional": false,
4371
+ "required": true
4372
+ },
4373
+ {
4374
+ "name": "referrerpolicy",
4375
+ "type": "\"\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\"",
4376
+ "mutable": false,
4377
+ "attr": "referrerpolicy",
4378
+ "reflectToAttr": false,
4379
+ "docs": "How much of the referrer to send when following the link.",
4380
+ "docsTags": [],
4381
+ "values": [
4382
+ {
4383
+ "type": "\"\""
4384
+ },
4385
+ {
4386
+ "value": "no-referrer",
4387
+ "type": "string"
4388
+ },
4389
+ {
4390
+ "value": "no-referrer-when-downgrade",
4391
+ "type": "string"
4392
+ },
4393
+ {
4394
+ "value": "origin",
4395
+ "type": "string"
4396
+ },
4397
+ {
4398
+ "value": "origin-when-cross-origin",
4399
+ "type": "string"
4400
+ },
4401
+ {
4402
+ "value": "same-origin",
4403
+ "type": "string"
4404
+ },
4405
+ {
4406
+ "value": "strict-origin",
4407
+ "type": "string"
4408
+ },
4409
+ {
4410
+ "value": "strict-origin-when-cross-origin",
4411
+ "type": "string"
4412
+ },
4413
+ {
4414
+ "value": "unsafe-url",
4415
+ "type": "string"
4416
+ }
4417
+ ],
4418
+ "optional": true,
4419
+ "required": false
4420
+ },
4421
+ {
4422
+ "name": "rel",
4423
+ "type": "string",
4424
+ "mutable": false,
4425
+ "attr": "rel",
4426
+ "reflectToAttr": false,
4427
+ "docs": "The relationship of the linked URL as space-separated link types.",
4428
+ "docsTags": [],
4429
+ "values": [
4430
+ {
4431
+ "type": "string"
4432
+ }
4433
+ ],
4434
+ "optional": true,
4435
+ "required": false
4436
+ },
4437
+ {
4438
+ "name": "submenuTriggerFor",
4439
+ "type": "string",
4440
+ "mutable": false,
4441
+ "attr": "submenu-trigger-for",
4442
+ "reflectToAttr": false,
4443
+ "docs": "This references the popover menu instance that the menu item is a trigger for. If this prop is set, then the variant will always be default.",
4444
+ "docsTags": [],
4445
+ "values": [
4446
+ {
4447
+ "type": "string"
4448
+ }
4449
+ ],
4450
+ "optional": true,
4451
+ "required": false
4452
+ },
4453
+ {
4454
+ "name": "target",
4455
+ "type": "string",
4456
+ "mutable": false,
4457
+ "attr": "target",
4458
+ "reflectToAttr": false,
4459
+ "docs": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
4460
+ "docsTags": [],
4461
+ "values": [
4462
+ {
4463
+ "type": "string"
4464
+ }
4465
+ ],
4466
+ "optional": true,
4467
+ "required": false
4468
+ },
4469
+ {
4470
+ "name": "variant",
4471
+ "type": "\"default\" | \"destructive\" | \"toggle\"",
4472
+ "mutable": true,
4473
+ "attr": "variant",
4474
+ "reflectToAttr": true,
4475
+ "docs": "The variant of the menu item.",
4476
+ "docsTags": [],
4477
+ "default": "\"default\"",
4478
+ "values": [
4479
+ {
4480
+ "value": "default",
4481
+ "type": "string"
4482
+ },
4483
+ {
4484
+ "value": "destructive",
4485
+ "type": "string"
4486
+ },
4487
+ {
4488
+ "value": "toggle",
4489
+ "type": "string"
4490
+ }
4491
+ ],
4492
+ "optional": false,
4493
+ "required": false
4494
+ }
4495
+ ],
4496
+ "methods": [],
4497
+ "events": [],
4498
+ "listeners": [
4499
+ {
4500
+ "event": "click",
4501
+ "capture": true,
4502
+ "passive": false
4503
+ }
4504
+ ],
4505
+ "styles": [],
4506
+ "slots": [
4507
+ {
4508
+ "name": "icon",
4509
+ "docs": "Content will be placed to the left of the menu item label."
4510
+ }
4511
+ ],
4512
+ "parts": [],
4513
+ "dependents": [
4514
+ "ic-popover-menu"
4515
+ ],
4516
+ "dependencies": [
4517
+ "ic-typography",
4518
+ "ic-button"
4519
+ ],
4520
+ "dependencyGraph": {
4521
+ "ic-menu-item": [
4522
+ "ic-typography",
4523
+ "ic-button"
4524
+ ],
4525
+ "ic-button": [
4526
+ "ic-loading-indicator",
4527
+ "ic-tooltip"
4528
+ ],
4529
+ "ic-loading-indicator": [
4530
+ "ic-typography"
4531
+ ],
4532
+ "ic-tooltip": [
4533
+ "ic-typography"
4534
+ ],
4535
+ "ic-popover-menu": [
4536
+ "ic-menu-item"
4537
+ ]
4538
+ }
4539
+ },
4210
4540
  {
4211
4541
  "filePath": "./src/components/ic-navigation-button/ic-navigation-button.tsx",
4212
4542
  "encapsulation": "shadow",
@@ -5129,6 +5459,136 @@
5129
5459
  ]
5130
5460
  }
5131
5461
  },
5462
+ {
5463
+ "filePath": "./src/components/ic-popover-menu/ic-popover-menu.tsx",
5464
+ "encapsulation": "shadow",
5465
+ "tag": "ic-popover-menu",
5466
+ "readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
5467
+ "docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
5468
+ "docsTags": [],
5469
+ "usage": {},
5470
+ "props": [
5471
+ {
5472
+ "name": "anchor",
5473
+ "type": "string",
5474
+ "mutable": false,
5475
+ "attr": "anchor",
5476
+ "reflectToAttr": false,
5477
+ "docs": "The ID of the element the popover menu will anchor itself to. This is required unless the popover is a submenu.",
5478
+ "docsTags": [],
5479
+ "values": [
5480
+ {
5481
+ "type": "string"
5482
+ }
5483
+ ],
5484
+ "optional": false,
5485
+ "required": false
5486
+ },
5487
+ {
5488
+ "name": "open",
5489
+ "type": "boolean",
5490
+ "mutable": true,
5491
+ "attr": "open",
5492
+ "reflectToAttr": true,
5493
+ "docs": "If `true`, the popover menu will be displayed.",
5494
+ "docsTags": [],
5495
+ "default": "undefined",
5496
+ "values": [
5497
+ {
5498
+ "type": "boolean"
5499
+ }
5500
+ ],
5501
+ "optional": false,
5502
+ "required": false
5503
+ },
5504
+ {
5505
+ "name": "submenuId",
5506
+ "type": "string",
5507
+ "mutable": false,
5508
+ "attr": "submenu-id",
5509
+ "reflectToAttr": false,
5510
+ "docs": "The unique identifier for a popover submenu.",
5511
+ "docsTags": [],
5512
+ "values": [
5513
+ {
5514
+ "type": "string"
5515
+ }
5516
+ ],
5517
+ "optional": true,
5518
+ "required": false
5519
+ }
5520
+ ],
5521
+ "methods": [],
5522
+ "events": [],
5523
+ "listeners": [
5524
+ {
5525
+ "event": "handleMenuItemClick",
5526
+ "capture": false,
5527
+ "passive": false
5528
+ },
5529
+ {
5530
+ "event": "triggerPopoverMenuInstance",
5531
+ "capture": true,
5532
+ "passive": false
5533
+ },
5534
+ {
5535
+ "event": "click",
5536
+ "target": "document",
5537
+ "capture": false,
5538
+ "passive": false
5539
+ },
5540
+ {
5541
+ "event": "keydown",
5542
+ "target": "document",
5543
+ "capture": false,
5544
+ "passive": false
5545
+ }
5546
+ ],
5547
+ "styles": [
5548
+ {
5549
+ "name": "--ic-z-index-popover",
5550
+ "annotation": "prop",
5551
+ "docs": "z-index of popover menu."
5552
+ },
5553
+ {
5554
+ "name": "--max-height",
5555
+ "annotation": "prop",
5556
+ "docs": "Maximum height of the popover menu."
5557
+ },
5558
+ {
5559
+ "name": "--popover-width",
5560
+ "annotation": "prop",
5561
+ "docs": "Default width of the popover menu."
5562
+ }
5563
+ ],
5564
+ "slots": [],
5565
+ "parts": [],
5566
+ "dependents": [],
5567
+ "dependencies": [
5568
+ "ic-menu-item",
5569
+ "ic-typography"
5570
+ ],
5571
+ "dependencyGraph": {
5572
+ "ic-popover-menu": [
5573
+ "ic-menu-item",
5574
+ "ic-typography"
5575
+ ],
5576
+ "ic-menu-item": [
5577
+ "ic-typography",
5578
+ "ic-button"
5579
+ ],
5580
+ "ic-button": [
5581
+ "ic-loading-indicator",
5582
+ "ic-tooltip"
5583
+ ],
5584
+ "ic-loading-indicator": [
5585
+ "ic-typography"
5586
+ ],
5587
+ "ic-tooltip": [
5588
+ "ic-typography"
5589
+ ]
5590
+ }
5591
+ },
5132
5592
  {
5133
5593
  "filePath": "./src/components/ic-radio-group/ic-radio-group.tsx",
5134
5594
  "encapsulation": "shadow",
@@ -6464,9 +6924,15 @@
6464
6924
  "mutable": false,
6465
6925
  "attr": "characters-until-suggestions",
6466
6926
  "reflectToAttr": false,
6467
- "docs": "The number of characters until suggestions appear for a searchable select.",
6468
- "docsTags": [],
6927
+ "docs": "",
6928
+ "docsTags": [
6929
+ {
6930
+ "name": "deprecated",
6931
+ "text": "This prop should not be used anymore."
6932
+ }
6933
+ ],
6469
6934
  "default": "0",
6935
+ "deprecation": "This prop should not be used anymore.",
6470
6936
  "values": [
6471
6937
  {
6472
6938
  "type": "number"
@@ -9259,7 +9725,13 @@
9259
9725
  "passive": true
9260
9726
  }
9261
9727
  ],
9262
- "styles": [],
9728
+ "styles": [
9729
+ {
9730
+ "name": "--ic-z-index-toast",
9731
+ "annotation": "prop",
9732
+ "docs": "z-index of toast"
9733
+ }
9734
+ ],
9263
9735
  "slots": [
9264
9736
  {
9265
9737
  "name": "action",
@@ -9833,10 +10305,13 @@
9833
10305
  "ic-input-validation",
9834
10306
  "ic-loading-indicator",
9835
10307
  "ic-menu",
10308
+ "ic-menu-group",
10309
+ "ic-menu-item",
9836
10310
  "ic-navigation-group",
9837
10311
  "ic-navigation-item",
9838
10312
  "ic-navigation-menu",
9839
10313
  "ic-page-header",
10314
+ "ic-popover-menu",
9840
10315
  "ic-radio-option",
9841
10316
  "ic-select",
9842
10317
  "ic-side-navigation",
@@ -9896,6 +10371,12 @@
9896
10371
  "ic-menu": [
9897
10372
  "ic-typography"
9898
10373
  ],
10374
+ "ic-menu-group": [
10375
+ "ic-typography"
10376
+ ],
10377
+ "ic-menu-item": [
10378
+ "ic-typography"
10379
+ ],
9899
10380
  "ic-navigation-group": [
9900
10381
  "ic-typography"
9901
10382
  ],
@@ -9908,6 +10389,9 @@
9908
10389
  "ic-page-header": [
9909
10390
  "ic-typography"
9910
10391
  ],
10392
+ "ic-popover-menu": [
10393
+ "ic-typography"
10394
+ ],
9911
10395
  "ic-radio-option": [
9912
10396
  "ic-typography"
9913
10397
  ],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ukic/docs",
3
- "version": "2.1.0-beta.10",
3
+ "version": "2.1.0-beta.11",
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": "01c84104c34316987766adfa69944b8072cc702a"
12
+ "gitHead": "c2853b352452de9cf09157c2b704ec7466b34d4c"
13
13
  }