@vidispine/vdt-mui 22.2.0-pre.1 → 22.2.0-pre.4
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.
- package/README.md +1 -26
- package/dist/index.es.js +2403 -0
- package/dist/index.js +2438 -0
- package/package.json +21 -11
package/README.md
CHANGED
|
@@ -1,28 +1,3 @@
|
|
|
1
|
-
# @vidispine/vdt-
|
|
1
|
+
# @vidispine/vdt-mui
|
|
2
2
|
|
|
3
3
|
See [Storybook](https://vidispine.github.io/vdt) for examples.
|
|
4
|
-
|
|
5
|
-
## Development
|
|
6
|
-
|
|
7
|
-
### Creating New Components
|
|
8
|
-
|
|
9
|
-
New components can be created from templates either by using the interactive prompt `yarn new:component`
|
|
10
|
-
or specifying the name and optional subdirectory `yarn new:component --name SidecarUpload --dir item`.
|
|
11
|
-
|
|
12
|
-
This will create a folder containing a handful of new files and will export the component.
|
|
13
|
-
|
|
14
|
-
- `{ComponentName}.js`
|
|
15
|
-
|
|
16
|
-
- The main component code plus PropTypes and MaterialUI styles.
|
|
17
|
-
|
|
18
|
-
- `{ComponentName}.stories.js`
|
|
19
|
-
|
|
20
|
-
- A Storybook example.
|
|
21
|
-
|
|
22
|
-
- `{ComponentName}.test.js`
|
|
23
|
-
|
|
24
|
-
- A basic test to check the component is mounted.
|
|
25
|
-
|
|
26
|
-
- `index.js`
|
|
27
|
-
|
|
28
|
-
- The main export with the MaterialUI [withStyles](https://material-ui.com/styles/basics/#higher-order-component-api) higher-order component.
|