Skip to content
This repository was archived by the owner on Jun 3, 2024. It is now read-only.

Commit ecb35a5

Browse files
Prop docs for Loading component
1 parent f777b61 commit ecb35a5

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

dash_core_components/Loading.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ class Loading(Component):
1010
Keyword arguments:
1111
- children (list | a list of or a singular dash component, string or number; optional): Array that holds components to render
1212
- id (string; optional)
13-
- loadingProp (string; optional)
13+
- loadingProp (string; optional): String that determines which prop to listen to when loading
1414
- className (string; optional): Additional CSS class for the root DOM node
15-
- loading (optional): . loading has the following type: dict containing keys 'loading', 'prop'.
15+
- loading (optional): Object that holds the loading prop, a bool that determines if the component is loading, and the actual
16+
prop that's causing the load as a String.. loading has the following type: dict containing keys 'loading', 'prop'.
1617
Those keys have the following types:
1718
- loading (boolean; optional)
1819
- prop (string; optional)

dash_core_components/metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2050,7 +2050,7 @@
20502050
"name": "string"
20512051
},
20522052
"required": false,
2053-
"description": ""
2053+
"description": "String that determines which prop to listen to when loading"
20542054
},
20552055
"className": {
20562056
"type": {
@@ -2074,7 +2074,7 @@
20742074
}
20752075
},
20762076
"required": false,
2077-
"description": ""
2077+
"description": "Object that holds the loading prop, a bool that determines if the component is loading, and the actual\nprop that's causing the load as a String."
20782078
}
20792079
}
20802080
},

src/components/Loading.react.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Loading.propTypes = {
9999
React.PropTypes.node,
100100
]),
101101

102-
/*
102+
/**
103103
* String that determines which prop to listen to when loading
104104
*/
105105
loadingProp: PropTypes.string,
@@ -109,5 +109,9 @@ Loading.propTypes = {
109109
*/
110110
className: PropTypes.string,
111111

112+
/**
113+
* Object that holds the loading prop, a bool that determines if the component is loading, and the actual
114+
* prop that's causing the load as a String.
115+
*/
112116
loading: PropTypes.shape({loading: PropTypes.bool, prop: PropTypes.string}),
113117
};

0 commit comments

Comments
 (0)