Skip to content

Commit 9cc8e88

Browse files
interactivellamainteractivellama
committed
Move Navigation to VerticalNavigation
1 parent 368cf1d commit 9cc8e88

File tree

19 files changed

+305
-284
lines changed

19 files changed

+305
-284
lines changed

‎components/component-docs.json

Lines changed: 129 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
},
4747
"route": "accordions",
4848
"display-name": "Accordions",
49-
"SLDS-component-path": "/components/accordions",
49+
"SLDS-component-path": "/components/accordion",
5050
"dependencies": [
5151
{
5252
"panel": {
@@ -282,7 +282,7 @@
282282
},
283283
"route": "alerts",
284284
"display-name": "Alerts",
285-
"SLDS-component-path": "/components/alerts",
285+
"SLDS-component-path": "/components/alert",
286286
"dependencies": [
287287
{
288288
"container": {
@@ -379,7 +379,7 @@
379379
"name": "bool"
380380
},
381381
"required": false,
382-
"description": "Boolean indicating if the appElement should be hidden. _Tested with snapshot testing._",
382+
"description": "Boolean indicating if the appElement should be hidden.",
383383
"defaultValue": {
384384
"value": "true",
385385
"computed": false
@@ -839,7 +839,7 @@
839839
},
840840
"route": "avatars",
841841
"display-name": "Avatars",
842-
"SLDS-component-path": "/components/avatars",
842+
"SLDS-component-path": "/components/avatar",
843843
"dependencies": []
844844
},
845845
"breadcrumb": {
@@ -1628,7 +1628,7 @@
16281628
},
16291629
"route": "stateful-buttons",
16301630
"display-name": "Stateful Buttons",
1631-
"SLDS-component-path": "/components/buttons/#flavor-stateful",
1631+
"SLDS-component-path": "/components/button/#flavor-stateful",
16321632
"dependencies": []
16331633
},
16341634
"button-group": {
@@ -2224,7 +2224,7 @@
22242224
},
22252225
"route": "checkboxes",
22262226
"display-name": "Checkboxes",
2227-
"SLDS-component-path": "/components/checkbox/",
2227+
"SLDS-component-path": "/components/checkbox",
22282228
"dependencies": []
22292229
},
22302230
"combobox": {
@@ -3057,7 +3057,7 @@
30573057
},
30583058
"route": "comboboxes",
30593059
"display-name": "Comboboxes",
3060-
"SLDS-component-path": "/components/comboboxes",
3060+
"SLDS-component-path": "/components/combobox",
30613061
"dependencies": []
30623062
},
30633063
"data-table": {
@@ -4725,7 +4725,7 @@
47254725
},
47264726
"route": "inputs",
47274727
"display-name": "Inputs",
4728-
"SLDS-component-path": "/components/input/",
4728+
"SLDS-component-path": "/components/input",
47294729
"dependencies": []
47304730
},
47314731
"global-header": {
@@ -5237,7 +5237,7 @@
52375237
},
52385238
"route": "global-navigation-bar",
52395239
"display-name": "Global Navigation Bar",
5240-
"SLDS-component-path": "/components/global-navigation#flavor-navigation-bar",
5240+
"SLDS-component-path": "/components/global-navigation",
52415241
"dependencies": [
52425242
{
52435243
"button": {
@@ -5981,7 +5981,6 @@
59815981
},
59825982
"route": "icon-settings",
59835983
"display-name": "Icon Settings",
5984-
"SLDS-component-path": "/components/icons-settings",
59855984
"dependencies": []
59865985
},
59875986
"illustration": {
@@ -6095,7 +6094,7 @@
60956094
},
60966095
"route": "illustrations",
60976096
"display-name": "Illustrations",
6098-
"SLDS-component-path": "/components/illustrations",
6097+
"SLDS-component-path": "/components/illustration",
60996098
"dependencies": []
61006099
},
61016100
"media-object": {
@@ -6151,7 +6150,7 @@
61516150
},
61526151
"route": "media-objects",
61536152
"display-name": "Media Objects",
6154-
"SLDS-component-path": "/components/utilities/media-objects/",
6153+
"SLDS-component-path": "/components/utilities/media-object",
61556154
"dependencies": []
61566155
},
61576156
"menu-dropdown": {
@@ -7337,7 +7336,7 @@
73377336
"name": "bool"
73387337
},
73397338
"required": false,
7340-
"description": "Boolean indicating if the appElement should be hidden. _Tested with snapshot testing._",
7339+
"description": "Boolean indicating if the appElement should be hidden.",
73417340
"defaultValue": {
73427341
"value": "true",
73437342
"computed": false
@@ -7595,105 +7594,6 @@
75957594
"SLDS-component-path": "/components/modals",
75967595
"dependencies": []
75977596
},
7598-
"navigation": {
7599-
"description": "Navigation represents a list of links that either take the user to another page or parts of the page the user is in.",
7600-
"methods": [
7601-
{
7602-
"name": "getId",
7603-
"docblock": null,
7604-
"modifiers": [],
7605-
"params": [],
7606-
"returns": null
7607-
},
7608-
{
7609-
"name": "getVariant",
7610-
"docblock": null,
7611-
"modifiers": [],
7612-
"params": [],
7613-
"returns": null
7614-
},
7615-
{
7616-
"name": "getSelectedId",
7617-
"docblock": null,
7618-
"modifiers": [],
7619-
"params": [],
7620-
"returns": null
7621-
}
7622-
],
7623-
"props": {
7624-
"id": {
7625-
"type": {
7626-
"name": "string"
7627-
},
7628-
"required": false,
7629-
"description": "HTML id for component. _Tested with snapshot testing._"
7630-
},
7631-
"className": {
7632-
"type": {
7633-
"name": "union",
7634-
"value": [
7635-
{
7636-
"name": "array"
7637-
},
7638-
{
7639-
"name": "object"
7640-
},
7641-
{
7642-
"name": "string"
7643-
}
7644-
]
7645-
},
7646-
"required": false,
7647-
"description": "CSS class names to be added to the container element. _Tested with snapshot testing._"
7648-
},
7649-
"categories": {
7650-
"type": {
7651-
"name": "array"
7652-
},
7653-
"required": false,
7654-
"description": "Array of categories. The required shape is: `{id: string, label: string, items: array}`. The required shape of an item is `{id: string, label: string, url: string}`. All item ids are expected to be unique. _Tested with snapshot testing._"
7655-
},
7656-
"selectedId": {
7657-
"type": {
7658-
"name": "string"
7659-
},
7660-
"required": false,
7661-
"description": "The ID of the item that is currently selected. Defaults to the ID of the first item. _Tested with Mocha framework._"
7662-
},
7663-
"onSelect": {
7664-
"type": {
7665-
"name": "func"
7666-
},
7667-
"required": false,
7668-
"description": "Triggered when the selection changes. It receives an event and an item object in the shape: `event, {item: [object] }`. _Tested with Mocha framework._"
7669-
},
7670-
"variant": {
7671-
"type": {
7672-
"name": "enum",
7673-
"value": [
7674-
{
7675-
"value": "'default'",
7676-
"computed": false
7677-
},
7678-
{
7679-
"value": "'shade'",
7680-
"computed": false
7681-
}
7682-
]
7683-
},
7684-
"required": false,
7685-
"description": "Determines component style. _Tested with snapshot testing._",
7686-
"defaultValue": {
7687-
"value": "'default'",
7688-
"computed": false
7689-
}
7690-
}
7691-
},
7692-
"route": "navigation",
7693-
"display-name": "Navigation",
7694-
"SLDS-component-path": "/components/navigation",
7695-
"dependencies": []
7696-
},
76977597
"panel": {
76987598
"description": "A panel provides detailed contextual information or contextual filtering options. [Filter](/components/filters/) component should be used as children. Menus within a Filter Popover will need to not have \"portal mounts\" and be inline.",
76997599
"methods": [],
@@ -9017,16 +8917,28 @@
90178917
"type": {
90188918
"name": "shape",
90198919
"value": {
8920+
"completedStep": {
8921+
"name": "string",
8922+
"required": false
8923+
},
8924+
"disabledStep": {
8925+
"name": "string",
8926+
"required": false
8927+
},
90208928
"percentage": {
90218929
"name": "string",
90228930
"required": false
8931+
},
8932+
"step": {
8933+
"name": "string",
8934+
"required": false
90238935
}
90248936
}
90258937
},
90268938
"required": false,
9027-
"description": "**Assistive text for accessibility**\nThis object is merged with the default props object on every render.\n* `percentage`: Label for Progress Bar. The default is `Progress: [this.props.value]%`",
8939+
"description": "**Assistive text for accessibility**\nThis object is merged with the default props object on every render.\n* `completedStep`: Label for a completed step. The default is `Completed Step`\n* `disabledStep`: Label for disabled step. The default is `Disabled Step`\n* `errorStep`: Label for a step with an error. The default is `Error Step`\n* `percentage`: Label for Progress Bar. The default is `Progress: [this.props.value]%`. You will need to calculate the percentage yourself if changing this string.\n* `step`: Label for a step. It will be typically followed by the number of the step such as \"Step 1\".",
90288940
"defaultValue": {
9029-
"value": "{}",
8941+
"value": "{\n completedStep: 'Completed',\n disabledStep: 'Disabled',\n errorStep: 'Error',\n step: 'Step',\n}",
90308942
"computed": false
90318943
}
90328944
},
@@ -9075,7 +8987,7 @@
90758987
"name": "array"
90768988
},
90778989
"required": false,
9078-
"description": "Stores all error steps. It is an array of step objects and usually there is only one error step, the current step.",
8990+
"description": "Stores all error steps. It is an array of step objects and usually there is only one error step, the current step. If an error occurs a second error icon should be placed to the left of related confirmation buttons (e.g. Cancel, Save) and an Error Popover should appear indicating there are errors. These additional items are NOT part of this component. This note was included for visibility purposes. Please refer to [SLDS website](https://www.lightningdesignsystem.com/components/progress-indicator/) for full details **",
90798991
"defaultValue": {
90808992
"value": "[]",
90818993
"computed": false
@@ -11233,7 +11145,7 @@
1123311145
},
1123411146
"route": "timepickers",
1123511147
"display-name": "Timepickers",
11236-
"SLDS-component-path": "/components/datepickers",
11148+
"SLDS-component-path": "/components/timepicker",
1123711149
"dependencies": []
1123811150
},
1123911151
"toast": {
@@ -11408,7 +11320,7 @@
1140811320
},
1140911321
"route": "toasts",
1141011322
"display-name": "Toasts",
11411-
"SLDS-component-path": "/components/toasts",
11323+
"SLDS-component-path": "/components/toast",
1141211324
"dependencies": [
1141311325
{
1141411326
"container": {
@@ -11994,7 +11906,106 @@
1199411906
},
1199511907
"route": "tree",
1199611908
"display-name": "Tree",
11997-
"SLDS-component-path": "/components/tree",
11909+
"SLDS-component-path": "/components/trees",
11910+
"dependencies": []
11911+
},
11912+
"vertical-navigation": {
11913+
"description": "Vertical Navigation represents a list of links that either take the user to another page or parts of the page the user is in.",
11914+
"methods": [
11915+
{
11916+
"name": "getId",
11917+
"docblock": null,
11918+
"modifiers": [],
11919+
"params": [],
11920+
"returns": null
11921+
},
11922+
{
11923+
"name": "getVariant",
11924+
"docblock": null,
11925+
"modifiers": [],
11926+
"params": [],
11927+
"returns": null
11928+
},
11929+
{
11930+
"name": "getSelectedId",
11931+
"docblock": null,
11932+
"modifiers": [],
11933+
"params": [],
11934+
"returns": null
11935+
}
11936+
],
11937+
"props": {
11938+
"id": {
11939+
"type": {
11940+
"name": "string"
11941+
},
11942+
"required": false,
11943+
"description": "HTML id for component. _Tested with snapshot testing._"
11944+
},
11945+
"className": {
11946+
"type": {
11947+
"name": "union",
11948+
"value": [
11949+
{
11950+
"name": "array"
11951+
},
11952+
{
11953+
"name": "object"
11954+
},
11955+
{
11956+
"name": "string"
11957+
}
11958+
]
11959+
},
11960+
"required": false,
11961+
"description": "CSS class names to be added to the container element. _Tested with snapshot testing._"
11962+
},
11963+
"categories": {
11964+
"type": {
11965+
"name": "array"
11966+
},
11967+
"required": false,
11968+
"description": "Array of categories. The required shape is: `{id: string, label: string, items: array}`. The required shape of an item is `{id: string, label: string, url: string}`. All item ids are expected to be unique. _Tested with snapshot testing._"
11969+
},
11970+
"selectedId": {
11971+
"type": {
11972+
"name": "string"
11973+
},
11974+
"required": false,
11975+
"description": "The ID of the item that is currently selected. Defaults to the ID of the first item. _Tested with Mocha framework._"
11976+
},
11977+
"onSelect": {
11978+
"type": {
11979+
"name": "func"
11980+
},
11981+
"required": false,
11982+
"description": "Triggered when the selection changes. It receives an event and an item object in the shape: `event, {item: [object] }`. _Tested with Mocha framework._"
11983+
},
11984+
"variant": {
11985+
"type": {
11986+
"name": "enum",
11987+
"value": [
11988+
{
11989+
"value": "'default'",
11990+
"computed": false
11991+
},
11992+
{
11993+
"value": "'shade'",
11994+
"computed": false
11995+
}
11996+
]
11997+
},
11998+
"required": false,
11999+
"description": "Determines component style. _Tested with snapshot testing._",
12000+
"defaultValue": {
12001+
"value": "'default'",
12002+
"computed": false
12003+
}
12004+
}
12005+
},
12006+
"route": "vertical-navigation",
12007+
"display-name": "Vertical Navigation",
12008+
"SLDS-component-path": "/components/vertical-navigation",
1199812009
"dependencies": []
1199912010
}
1200012011
}

‎components/index.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,5 +238,8 @@ export UtilityIcon from './utilities/utility-icon';
238238
export SLDSTree from './tree';
239239
export Tree from './tree';
240240

241+
export SLDSVerticalNavigation from './vertical-navigation';
242+
export VerticalNavigation from './vertical-navigation';
243+
241244
// Library utilities
242245
export log from '../utilities/log';

0 commit comments

Comments
 (0)