Skip to content

Add Progress Bar Component #1773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Apr 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 123 additions & 1 deletion components/component-docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -10948,7 +10948,129 @@
"SLDS-component-path": "/components/progress-indicator",
"dependencies": []
},
"progress-ring": {
"progress-bar": {
"description": "A progress bar component communicates to the user the progress of a particular process.",
"methods": [
{
"name": "getId",
"docblock": "Get the progress bar's HTML id. Generate a new one if no ID present.",
"modifiers": [],
"params": [],
"returns": null,
"description": "Get the progress bars's HTML id. Generate a new one if no ID present."
},
{
"name": "getDescription",
"docblock": "Get the the description for progress bar. Doesn't show description if label is not given.",
"modifiers": [],
"params": [],
"returns": {
"description": "Progress Bar Description Container",
"type": {
"name": "string"
}
},
"description": "Get the the description for progress bar. Doesn't show description if label is not given."
}
],
"props": {
"id": {
"type": {
"name": "string"
},
"required": false,
"description": "HTML id for component."
},
"className": {
"type": {
"name": "union",
"value": [
{
"name": "array"
},
{
"name": "object"
},
{
"name": "string"
}
]
},
"required": false,
"description": "CSS classes to be added to tag with `.slds-progress-bar`. Uses `classNames` [API](https://github.com/JedWatson/classnames)."
},
"label": {
"type": {
"name": "string"
},
"required": false,
"description": "Label for the progress bar."
},
"radius": {
"type": {
"name": "enum",
"value": [
{
"value": "'circular'",
"computed": false
}
]
},
"required": false,
"description": "Border radius of Progress Bar."
},
"color": {
"type": {
"name": "enum",
"value": [
{
"value": "'success'",
"computed": false
}
]
},
"required": false,
"description": "Color for filling the progress bar"
},
"thickness": {
"type": {
"name": "enum",
"value": [
{
"value": "'x-small'",
"computed": false
},
{
"value": "'small'",
"computed": false
},
{
"value": "'medium'",
"computed": false
},
{
"value": "'large'",
"computed": false
}
]
},
"required": false,
"description": "Thickness of the progress bar"
},
"value": {
"type": {
"name": "number"
},
"required": true,
"description": "Percentage of progress completion, ranging [0, 100]."
}
},
"route": "progress-bars",
"display-name": "Progress Bars",
"SLDS-component-path": "/components/progress-bar",
"dependencies": []
},
"progress-ring": {
"description": "Customizable and configurable progress ring. Will display progress in a circular progress bar factor, and is capable of displaying iconography inside of the ring structure.",
"methods": [
{
Expand Down
3 changes: 3 additions & 0 deletions components/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,9 @@ export PopoverTooltip from './tooltip';
export SLDSTooltip from './tooltip';
export Tooltip from './tooltip';

export SLDSProgressBar from './progress-bar';
export ProgressBar from './progress-bar';

export SLDSProgressIndicator from './progress-indicator';
export ProgressIndicator from './progress-indicator';

Expand Down
Loading