Skip to content

Commit

Permalink
Update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
m4theushw committed Apr 21, 2021
1 parent 2681c92 commit ade76e8
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 105 deletions.
22 changes: 11 additions & 11 deletions docs/pages/api-docs/loading-button.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
"children": { "type": { "name": "node" } },
"classes": { "type": { "name": "object" } },
"disabled": { "type": { "name": "bool" } },
"pending": { "type": { "name": "bool" } },
"pendingIndicator": {
"loading": { "type": { "name": "bool" } },
"loadingIndicator": {
"type": { "name": "node" },
"default": "<CircularProgress color=\"inherit\" size={16} />"
},
"pendingPosition": {
"loadingPosition": {
"type": {
"name": "custom",
"description": "'start'<br>&#124;&nbsp;'end'<br>&#124;&nbsp;'center'"
Expand All @@ -20,14 +20,14 @@
"styles": {
"classes": [
"root",
"pending",
"pendingIndicator",
"pendingIndicatorCenter",
"pendingIndicatorStart",
"pendingIndicatorEnd",
"endIconPendingEnd",
"startIconPendingStart",
"labelPendingCenter"
"loading",
"loadingIndicator",
"loadingIndicatorCenter",
"loadingIndicatorStart",
"loadingIndicatorEnd",
"endIconLoadingEnd",
"startIconLoadingStart",
"labelLoadingCenter"
],
"globalClasses": {},
"name": "MuiLoadingButton"
Expand Down
72 changes: 0 additions & 72 deletions docs/pages/api-docs/loading-button.md

This file was deleted.

44 changes: 22 additions & 22 deletions docs/translations/api-docs/loading-button/loading-button.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,50 +4,50 @@
"children": "The content of the component.",
"classes": "Override or extend the styles applied to the component. See <a href=\"#css\">CSS API</a> below for more details.",
"disabled": "If <code>true</code>, the component is disabled.",
"pending": "If <code>true</code>, the pending indicator is shown.",
"pendingIndicator": "Element placed before the children if the button is in pending state.",
"pendingPosition": "The pending indicator can be positioned on the start, end, or the center of the button."
"loading": "If <code>true</code>, the loading indicator is shown.",
"loadingIndicator": "Element placed before the children if the button is in loading state.",
"loadingPosition": "The loading indicator can be positioned on the start, end, or the center of the button."
},
"classDescriptions": {
"root": { "description": "Styles applied to the root element." },
"pending": {
"loading": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "<code>pending={true}</code>"
"conditions": "<code>loading={true}</code>"
},
"pendingIndicator": {
"loadingIndicator": {
"description": "Styles applied to {{nodeName}}.",
"nodeName": "the pendingIndicator element"
"nodeName": "the loadingIndicator element"
},
"pendingIndicatorCenter": {
"loadingIndicatorCenter": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the pendingIndicator element",
"conditions": "<code>pendingPosition=\"center\"</code>"
"nodeName": "the loadingIndicator element",
"conditions": "<code>loadingPosition=\"center\"</code>"
},
"pendingIndicatorStart": {
"loadingIndicatorStart": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the pendingIndicator element",
"conditions": "<code>pendingPosition=\"start\"</code>"
"nodeName": "the loadingIndicator element",
"conditions": "<code>loadingPosition=\"start\"</code>"
},
"pendingIndicatorEnd": {
"loadingIndicatorEnd": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the pendingIndicator element",
"conditions": "<code>pendingPosition=\"end\"</code>"
"nodeName": "the loadingIndicator element",
"conditions": "<code>loadingPosition=\"end\"</code>"
},
"endIconPendingEnd": {
"endIconLoadingEnd": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the endIcon element",
"conditions": "<code>pending={true}</code> and <code>pendingPosition=\"end\"</code>"
"conditions": "<code>loading={true}</code> and <code>loadingPosition=\"end\"</code>"
},
"startIconPendingStart": {
"startIconLoadingStart": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the startIcon element",
"conditions": "<code>pending={true}</code> and <code>pendingPosition=\"start\"</code>"
"conditions": "<code>loading={true}</code> and <code>loadingPosition=\"start\"</code>"
},
"labelPendingCenter": {
"labelLoadingCenter": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the label element",
"conditions": "<code>pending={true}</code> and <code>pendingPosition=\"center\"</code>"
"conditions": "<code>loading={true}</code> and <code>loadingPosition=\"center\"</code>"
}
}
}

0 comments on commit ade76e8

Please sign in to comment.