@proximus/lavender-progress-stepper 1.4.20-alpha.9 → 1.4.20-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -28,20 +28,11 @@
28
28
  "name": "ProgressStepper",
29
29
  "slots": [
30
30
  {
31
- "description": "`px-progress-stepper-item` elements.",
31
+ "description": "`px-progress-stepper-item` and `px-progress-stepper-link` elements.",
32
32
  "name": ""
33
33
  }
34
34
  ],
35
35
  "members": [
36
- {
37
- "kind": "field",
38
- "name": "nativeName",
39
- "type": {
40
- "text": "string"
41
- },
42
- "static": true,
43
- "default": "'ol'"
44
- },
45
36
  {
46
37
  "kind": "field",
47
38
  "name": "template",
@@ -101,6 +92,11 @@
101
92
  "kind": "method",
102
93
  "name": "configureChildren"
103
94
  },
95
+ {
96
+ "kind": "method",
97
+ "name": "#updateNavigation",
98
+ "privacy": "private"
99
+ },
104
100
  {
105
101
  "kind": "field",
106
102
  "name": "$slot",
@@ -144,6 +140,13 @@
144
140
  },
145
141
  "description": "Name of the `px-icon-set` used for the items icons. Defaults to `lavender`."
146
142
  },
143
+ {
144
+ "name": "aria-label",
145
+ "type": {
146
+ "text": "string"
147
+ },
148
+ "description": "Navigation label when steps contain links."
149
+ },
147
150
  {
148
151
  "type": {
149
152
  "text": "\"default\" | \"vertical\" | \"horizontal\""
@@ -181,7 +184,7 @@
181
184
  }
182
185
  ],
183
186
  "superclass": {
184
- "name": "PxElement",
187
+ "name": "WithExtraAttributes",
185
188
  "package": "@proximus/lavender-common"
186
189
  },
187
190
  "summary": "Displays the progression of a user through a sequence of steps.",
@@ -226,23 +229,162 @@
226
229
  },
227
230
  {
228
231
  "kind": "javascript-module",
229
- "path": "src/ProgressStepperItem.ts",
232
+ "path": "src/ProgressStepperBase.ts",
230
233
  "declarations": [
231
234
  {
232
235
  "kind": "variable",
233
- "name": "PROGRESS_STEPPER_ITEM_CONNECTED_EVENT",
236
+ "name": "progressStepperItemStateValues",
234
237
  "type": {
235
- "text": "string"
238
+ "text": "array"
236
239
  },
237
- "default": "'px-progress-stepper-item-connected'"
240
+ "default": "[ '', 'upcoming', 'current', 'completed', ]"
238
241
  },
239
242
  {
240
- "kind": "variable",
243
+ "kind": "class",
244
+ "description": "",
245
+ "name": "ProgressStepperBase",
246
+ "members": [
247
+ {
248
+ "kind": "method",
249
+ "name": "createItemTemplate",
250
+ "privacy": "protected",
251
+ "static": true,
252
+ "parameters": [
253
+ {
254
+ "name": "titleTag",
255
+ "type": {
256
+ "text": "'span' | 'a'"
257
+ }
258
+ }
259
+ ]
260
+ },
261
+ {
262
+ "kind": "method",
263
+ "name": "updateState",
264
+ "parameters": [
265
+ {
266
+ "name": "attrName",
267
+ "type": {
268
+ "text": "string"
269
+ }
270
+ },
271
+ {
272
+ "name": "newValue",
273
+ "type": {
274
+ "text": "string"
275
+ }
276
+ },
277
+ {
278
+ "name": "attrValues",
279
+ "type": {
280
+ "text": "string[]"
281
+ }
282
+ }
283
+ ]
284
+ },
285
+ {
286
+ "kind": "method",
287
+ "name": "applyAriaCurrent",
288
+ "privacy": "protected"
289
+ },
290
+ {
291
+ "kind": "field",
292
+ "name": "$el",
293
+ "type": {
294
+ "text": "HTMLLIElement"
295
+ },
296
+ "readonly": true
297
+ },
298
+ {
299
+ "kind": "field",
300
+ "name": "$title",
301
+ "readonly": true
302
+ },
303
+ {
304
+ "kind": "field",
305
+ "name": "$indicatorNumber",
306
+ "readonly": true
307
+ },
308
+ {
309
+ "kind": "field",
310
+ "name": "$icon",
311
+ "readonly": true
312
+ },
313
+ {
314
+ "kind": "field",
315
+ "name": "$shownSR",
316
+ "readonly": true
317
+ },
318
+ {
319
+ "kind": "field",
320
+ "name": "state"
321
+ },
322
+ {
323
+ "kind": "field",
324
+ "name": "item"
325
+ },
326
+ {
327
+ "kind": "field",
328
+ "name": "iconFrom"
329
+ },
330
+ {
331
+ "kind": "field",
332
+ "name": "completedLabel"
333
+ }
334
+ ],
335
+ "attributes": [
336
+ {
337
+ "name": "state"
338
+ },
339
+ {
340
+ "name": "item"
341
+ },
342
+ {
343
+ "name": "lastchild"
344
+ },
345
+ {
346
+ "name": "icon-from"
347
+ },
348
+ {
349
+ "name": "completed-label"
350
+ }
351
+ ],
352
+ "superclass": {
353
+ "name": "WithExtraAttributes",
354
+ "package": "@proximus/lavender-common"
355
+ }
356
+ }
357
+ ],
358
+ "exports": [
359
+ {
360
+ "kind": "js",
241
361
  "name": "progressStepperItemStateValues",
362
+ "declaration": {
363
+ "name": "progressStepperItemStateValues",
364
+ "module": "src/ProgressStepperBase.ts"
365
+ }
366
+ },
367
+ {
368
+ "kind": "js",
369
+ "name": "ProgressStepperBase",
370
+ "declaration": {
371
+ "name": "ProgressStepperBase",
372
+ "module": "src/ProgressStepperBase.ts"
373
+ }
374
+ }
375
+ ]
376
+ },
377
+ {
378
+ "kind": "javascript-module",
379
+ "path": "src/ProgressStepperItem.ts",
380
+ "declarations": [
381
+ {
382
+ "kind": "variable",
383
+ "name": "PROGRESS_STEPPER_ITEM_CONNECTED_EVENT",
242
384
  "type": {
243
- "text": "array"
385
+ "text": "string"
244
386
  },
245
- "default": "[ '', 'upcoming', 'current', 'completed', ]"
387
+ "default": "'px-progress-stepper-item-connected'"
246
388
  },
247
389
  {
248
390
  "kind": "class",
@@ -250,7 +392,7 @@
250
392
  "name": "ProgressStepperItem",
251
393
  "slots": [
252
394
  {
253
- "description": "Title of the step. Rendered inside a link when `href` is set.",
395
+ "description": "Title of the step.",
254
396
  "name": "title"
255
397
  },
256
398
  {
@@ -261,19 +403,28 @@
261
403
  "members": [
262
404
  {
263
405
  "kind": "field",
264
- "name": "nativeName",
265
- "type": {
266
- "text": "string"
267
- },
406
+ "name": "template",
407
+ "privacy": "protected",
268
408
  "static": true,
269
- "default": "'li'"
409
+ "readonly": true
270
410
  },
271
411
  {
272
- "kind": "field",
273
- "name": "template",
412
+ "kind": "method",
413
+ "name": "createItemTemplate",
274
414
  "privacy": "protected",
275
415
  "static": true,
276
- "readonly": true
416
+ "parameters": [
417
+ {
418
+ "name": "titleTag",
419
+ "type": {
420
+ "text": "'span' | 'a'"
421
+ }
422
+ }
423
+ ],
424
+ "inheritedFrom": {
425
+ "name": "ProgressStepperBase",
426
+ "module": "src/ProgressStepperBase.ts"
427
+ }
277
428
  },
278
429
  {
279
430
  "kind": "method",
@@ -297,49 +448,100 @@
297
448
  "text": "string[]"
298
449
  }
299
450
  }
300
- ]
451
+ ],
452
+ "inheritedFrom": {
453
+ "name": "ProgressStepperBase",
454
+ "module": "src/ProgressStepperBase.ts"
455
+ }
301
456
  },
302
457
  {
303
458
  "kind": "method",
304
- "name": "#renderTitle",
305
- "privacy": "private",
306
- "description": "Swaps the title wrapper between a `<span>` and an `<a>` depending on `href`."
459
+ "name": "applyAriaCurrent",
460
+ "privacy": "protected",
461
+ "inheritedFrom": {
462
+ "name": "ProgressStepperBase",
463
+ "module": "src/ProgressStepperBase.ts"
464
+ }
307
465
  },
308
466
  {
309
- "kind": "method",
310
- "name": "#applyAriaCurrent",
311
- "privacy": "private"
467
+ "kind": "field",
468
+ "name": "$el",
469
+ "type": {
470
+ "text": "HTMLLIElement"
471
+ },
472
+ "readonly": true,
473
+ "inheritedFrom": {
474
+ "name": "ProgressStepperBase",
475
+ "module": "src/ProgressStepperBase.ts"
476
+ }
312
477
  },
313
478
  {
314
479
  "kind": "field",
315
480
  "name": "$title",
316
- "readonly": true
481
+ "readonly": true,
482
+ "inheritedFrom": {
483
+ "name": "ProgressStepperBase",
484
+ "module": "src/ProgressStepperBase.ts"
485
+ }
317
486
  },
318
487
  {
319
488
  "kind": "field",
320
489
  "name": "$indicatorNumber",
321
- "readonly": true
490
+ "readonly": true,
491
+ "inheritedFrom": {
492
+ "name": "ProgressStepperBase",
493
+ "module": "src/ProgressStepperBase.ts"
494
+ }
322
495
  },
323
496
  {
324
497
  "kind": "field",
325
498
  "name": "$icon",
326
- "readonly": true
499
+ "readonly": true,
500
+ "inheritedFrom": {
501
+ "name": "ProgressStepperBase",
502
+ "module": "src/ProgressStepperBase.ts"
503
+ }
327
504
  },
328
505
  {
329
506
  "kind": "field",
330
- "name": "state"
507
+ "name": "$shownSR",
508
+ "readonly": true,
509
+ "inheritedFrom": {
510
+ "name": "ProgressStepperBase",
511
+ "module": "src/ProgressStepperBase.ts"
512
+ }
331
513
  },
332
514
  {
333
515
  "kind": "field",
334
- "name": "href"
516
+ "name": "state",
517
+ "inheritedFrom": {
518
+ "name": "ProgressStepperBase",
519
+ "module": "src/ProgressStepperBase.ts"
520
+ }
335
521
  },
336
522
  {
337
523
  "kind": "field",
338
- "name": "item"
524
+ "name": "item",
525
+ "inheritedFrom": {
526
+ "name": "ProgressStepperBase",
527
+ "module": "src/ProgressStepperBase.ts"
528
+ }
339
529
  },
340
530
  {
341
531
  "kind": "field",
342
- "name": "iconFrom"
532
+ "name": "iconFrom",
533
+ "inheritedFrom": {
534
+ "name": "ProgressStepperBase",
535
+ "module": "src/ProgressStepperBase.ts"
536
+ }
537
+ },
538
+ {
539
+ "kind": "field",
540
+ "name": "completedLabel",
541
+ "inheritedFrom": {
542
+ "name": "ProgressStepperBase",
543
+ "module": "src/ProgressStepperBase.ts"
544
+ }
343
545
  }
344
546
  ],
345
547
  "events": [
@@ -356,34 +558,54 @@
356
558
  "type": {
357
559
  "text": "\"upcoming\" | \"current\" | \"completed\""
358
560
  },
359
- "description": "State of the step. Defaults to `upcoming`."
561
+ "description": "State of the step. Defaults to `upcoming`.",
562
+ "inheritedFrom": {
563
+ "name": "ProgressStepperBase",
564
+ "module": "src/ProgressStepperBase.ts"
565
+ }
360
566
  },
361
567
  {
362
- "name": "href",
568
+ "name": "icon-from",
363
569
  "type": {
364
570
  "text": "string"
365
571
  },
366
- "description": "Makes the title a link pointing to this URL."
572
+ "description": "Name of the `px-icon-set` used for the check icon. Defaults to `lavender`.",
573
+ "inheritedFrom": {
574
+ "name": "ProgressStepperBase",
575
+ "module": "src/ProgressStepperBase.ts"
576
+ }
367
577
  },
368
578
  {
369
- "name": "item"
579
+ "name": "completed-label",
580
+ "type": {
581
+ "text": "string"
582
+ },
583
+ "description": "Screen-reader text for a completed step.",
584
+ "inheritedFrom": {
585
+ "name": "ProgressStepperBase",
586
+ "module": "src/ProgressStepperBase.ts"
587
+ }
370
588
  },
371
589
  {
372
- "name": "lastchild"
590
+ "name": "item",
591
+ "inheritedFrom": {
592
+ "name": "ProgressStepperBase",
593
+ "module": "src/ProgressStepperBase.ts"
594
+ }
373
595
  },
374
596
  {
375
- "name": "icon-from",
376
- "type": {
377
- "text": "string"
378
- },
379
- "description": "Name of the `px-icon-set` used for the check icon. Defaults to `lavender`."
597
+ "name": "lastchild",
598
+ "inheritedFrom": {
599
+ "name": "ProgressStepperBase",
600
+ "module": "src/ProgressStepperBase.ts"
601
+ }
380
602
  }
381
603
  ],
382
604
  "superclass": {
383
- "name": "PxElement",
384
- "package": "@proximus/lavender-common"
605
+ "name": "ProgressStepperBase",
606
+ "module": "/src/ProgressStepperBase"
385
607
  },
386
- "summary": "A single step of a `px-progress-stepper`.",
608
+ "summary": "A non-clickable step of a `px-progress-stepper`.",
387
609
  "tagName": "px-progress-stepper-item",
388
610
  "customElement": true
389
611
  }
@@ -391,17 +613,17 @@
391
613
  "exports": [
392
614
  {
393
615
  "kind": "js",
394
- "name": "PROGRESS_STEPPER_ITEM_CONNECTED_EVENT",
616
+ "name": "progressStepperItemStateValues",
395
617
  "declaration": {
396
- "name": "PROGRESS_STEPPER_ITEM_CONNECTED_EVENT",
397
- "module": "src/ProgressStepperItem.ts"
618
+ "name": "progressStepperItemStateValues",
619
+ "module": "./ProgressStepperBase"
398
620
  }
399
621
  },
400
622
  {
401
623
  "kind": "js",
402
- "name": "progressStepperItemStateValues",
624
+ "name": "PROGRESS_STEPPER_ITEM_CONNECTED_EVENT",
403
625
  "declaration": {
404
- "name": "progressStepperItemStateValues",
626
+ "name": "PROGRESS_STEPPER_ITEM_CONNECTED_EVENT",
405
627
  "module": "src/ProgressStepperItem.ts"
406
628
  }
407
629
  },
@@ -423,6 +645,280 @@
423
645
  }
424
646
  ]
425
647
  },
648
+ {
649
+ "kind": "javascript-module",
650
+ "path": "src/ProgressStepperLink.ts",
651
+ "declarations": [
652
+ {
653
+ "kind": "variable",
654
+ "name": "PROGRESS_STEPPER_LINK_CONNECTED_EVENT",
655
+ "type": {
656
+ "text": "string"
657
+ },
658
+ "default": "'px-progress-stepper-link-connected'"
659
+ },
660
+ {
661
+ "kind": "class",
662
+ "description": "",
663
+ "name": "ProgressStepperLink",
664
+ "slots": [
665
+ {
666
+ "description": "Title of the step, rendered as a link.",
667
+ "name": "title"
668
+ },
669
+ {
670
+ "description": "Helper text displayed below the title.",
671
+ "name": "helper"
672
+ }
673
+ ],
674
+ "members": [
675
+ {
676
+ "kind": "field",
677
+ "name": "template",
678
+ "privacy": "protected",
679
+ "static": true,
680
+ "readonly": true
681
+ },
682
+ {
683
+ "kind": "field",
684
+ "name": "href"
685
+ },
686
+ {
687
+ "kind": "method",
688
+ "name": "createItemTemplate",
689
+ "privacy": "protected",
690
+ "static": true,
691
+ "parameters": [
692
+ {
693
+ "name": "titleTag",
694
+ "type": {
695
+ "text": "'span' | 'a'"
696
+ }
697
+ }
698
+ ],
699
+ "inheritedFrom": {
700
+ "name": "ProgressStepperBase",
701
+ "module": "src/ProgressStepperBase.ts"
702
+ }
703
+ },
704
+ {
705
+ "kind": "method",
706
+ "name": "updateState",
707
+ "parameters": [
708
+ {
709
+ "name": "attrName",
710
+ "type": {
711
+ "text": "string"
712
+ }
713
+ },
714
+ {
715
+ "name": "newValue",
716
+ "type": {
717
+ "text": "string"
718
+ }
719
+ },
720
+ {
721
+ "name": "attrValues",
722
+ "type": {
723
+ "text": "string[]"
724
+ }
725
+ }
726
+ ],
727
+ "inheritedFrom": {
728
+ "name": "ProgressStepperBase",
729
+ "module": "src/ProgressStepperBase.ts"
730
+ }
731
+ },
732
+ {
733
+ "kind": "method",
734
+ "name": "applyAriaCurrent",
735
+ "privacy": "protected",
736
+ "inheritedFrom": {
737
+ "name": "ProgressStepperBase",
738
+ "module": "src/ProgressStepperBase.ts"
739
+ }
740
+ },
741
+ {
742
+ "kind": "field",
743
+ "name": "$el",
744
+ "type": {
745
+ "text": "HTMLLIElement"
746
+ },
747
+ "readonly": true,
748
+ "inheritedFrom": {
749
+ "name": "ProgressStepperBase",
750
+ "module": "src/ProgressStepperBase.ts"
751
+ }
752
+ },
753
+ {
754
+ "kind": "field",
755
+ "name": "$title",
756
+ "readonly": true,
757
+ "inheritedFrom": {
758
+ "name": "ProgressStepperBase",
759
+ "module": "src/ProgressStepperBase.ts"
760
+ }
761
+ },
762
+ {
763
+ "kind": "field",
764
+ "name": "$indicatorNumber",
765
+ "readonly": true,
766
+ "inheritedFrom": {
767
+ "name": "ProgressStepperBase",
768
+ "module": "src/ProgressStepperBase.ts"
769
+ }
770
+ },
771
+ {
772
+ "kind": "field",
773
+ "name": "$icon",
774
+ "readonly": true,
775
+ "inheritedFrom": {
776
+ "name": "ProgressStepperBase",
777
+ "module": "src/ProgressStepperBase.ts"
778
+ }
779
+ },
780
+ {
781
+ "kind": "field",
782
+ "name": "$shownSR",
783
+ "readonly": true,
784
+ "inheritedFrom": {
785
+ "name": "ProgressStepperBase",
786
+ "module": "src/ProgressStepperBase.ts"
787
+ }
788
+ },
789
+ {
790
+ "kind": "field",
791
+ "name": "state",
792
+ "inheritedFrom": {
793
+ "name": "ProgressStepperBase",
794
+ "module": "src/ProgressStepperBase.ts"
795
+ }
796
+ },
797
+ {
798
+ "kind": "field",
799
+ "name": "item",
800
+ "inheritedFrom": {
801
+ "name": "ProgressStepperBase",
802
+ "module": "src/ProgressStepperBase.ts"
803
+ }
804
+ },
805
+ {
806
+ "kind": "field",
807
+ "name": "iconFrom",
808
+ "inheritedFrom": {
809
+ "name": "ProgressStepperBase",
810
+ "module": "src/ProgressStepperBase.ts"
811
+ }
812
+ },
813
+ {
814
+ "kind": "field",
815
+ "name": "completedLabel",
816
+ "inheritedFrom": {
817
+ "name": "ProgressStepperBase",
818
+ "module": "src/ProgressStepperBase.ts"
819
+ }
820
+ }
821
+ ],
822
+ "events": [
823
+ {
824
+ "name": "PROGRESS_STEPPER_LINK_CONNECTED_EVENT",
825
+ "type": {
826
+ "text": "CustomEvent"
827
+ }
828
+ }
829
+ ],
830
+ "attributes": [
831
+ {
832
+ "name": "href",
833
+ "type": {
834
+ "text": "string"
835
+ },
836
+ "description": "URL of the step."
837
+ },
838
+ {
839
+ "name": "state",
840
+ "type": {
841
+ "text": "\"upcoming\" | \"current\" | \"completed\""
842
+ },
843
+ "description": "State of the step. Defaults to `upcoming`.",
844
+ "inheritedFrom": {
845
+ "name": "ProgressStepperBase",
846
+ "module": "src/ProgressStepperBase.ts"
847
+ }
848
+ },
849
+ {
850
+ "name": "icon-from",
851
+ "type": {
852
+ "text": "string"
853
+ },
854
+ "description": "Name of the `px-icon-set` used for the check icon. Defaults to `lavender`.",
855
+ "inheritedFrom": {
856
+ "name": "ProgressStepperBase",
857
+ "module": "src/ProgressStepperBase.ts"
858
+ }
859
+ },
860
+ {
861
+ "name": "completed-label",
862
+ "type": {
863
+ "text": "string"
864
+ },
865
+ "description": "Screen-reader text for a completed step.",
866
+ "inheritedFrom": {
867
+ "name": "ProgressStepperBase",
868
+ "module": "src/ProgressStepperBase.ts"
869
+ }
870
+ },
871
+ {
872
+ "name": "item",
873
+ "inheritedFrom": {
874
+ "name": "ProgressStepperBase",
875
+ "module": "src/ProgressStepperBase.ts"
876
+ }
877
+ },
878
+ {
879
+ "name": "lastchild",
880
+ "inheritedFrom": {
881
+ "name": "ProgressStepperBase",
882
+ "module": "src/ProgressStepperBase.ts"
883
+ }
884
+ }
885
+ ],
886
+ "superclass": {
887
+ "name": "ProgressStepperBase",
888
+ "module": "/src/ProgressStepperBase"
889
+ },
890
+ "summary": "A clickable step of a `px-progress-stepper`.",
891
+ "tagName": "px-progress-stepper-link",
892
+ "customElement": true
893
+ }
894
+ ],
895
+ "exports": [
896
+ {
897
+ "kind": "js",
898
+ "name": "PROGRESS_STEPPER_LINK_CONNECTED_EVENT",
899
+ "declaration": {
900
+ "name": "PROGRESS_STEPPER_LINK_CONNECTED_EVENT",
901
+ "module": "src/ProgressStepperLink.ts"
902
+ }
903
+ },
904
+ {
905
+ "kind": "js",
906
+ "name": "ProgressStepperLink",
907
+ "declaration": {
908
+ "name": "ProgressStepperLink",
909
+ "module": "src/ProgressStepperLink.ts"
910
+ }
911
+ },
912
+ {
913
+ "kind": "custom-element-definition",
914
+ "name": "px-progress-stepper-link",
915
+ "declaration": {
916
+ "name": "ProgressStepperLink",
917
+ "module": "src/ProgressStepperLink.ts"
918
+ }
919
+ }
920
+ ]
921
+ },
426
922
  {
427
923
  "kind": "javascript-module",
428
924
  "path": "src/index.ts",
@@ -443,6 +939,14 @@
443
939
  "name": "*",
444
940
  "module": "src/ProgressStepperItem"
445
941
  }
942
+ },
943
+ {
944
+ "kind": "js",
945
+ "name": "*",
946
+ "declaration": {
947
+ "name": "*",
948
+ "module": "src/ProgressStepperLink"
949
+ }
446
950
  }
447
951
  ]
448
952
  },