@carto/ps-react-ui 0.1.0-alpha.7 → 1.0.0

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.
Files changed (6) hide show
  1. package/README.md +12 -14
  2. package/dist/ps-react-ui.es.js +733 -662
  3. package/dist/ps-react-ui.umd.js +15 -15
  4. package/dist/types/components/input-file/InputFile.d.ts +8 -5
  5. package/dist/types/components/input-file/types.d.ts +3 -1
  6. package/package.json +6 -5
package/README.md CHANGED
@@ -1,23 +1,21 @@
1
- # CARTO PS Library - React UI
1
+ # CARTO PS React Library - React UI
2
2
 
3
- This repository contains the packages with react ui helpers.
3
+ This repository contains the packages with react hooks helpers.
4
4
 
5
- The see what helpers are available, the interfaces and examples, see [docs](https://github.com/CartoDB/carto-ps-lib/blob/main/packages/react-ui/docs/README.md) section.
5
+ ## Installation
6
6
 
7
- ## Contributing
8
-
9
- See [the contributing guide](https://github.com/CartoDB/carto-ps-lib/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started with our project.
7
+ Install @carto/ps-react-ui like dependence:
10
8
 
11
- If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](https://github.com/CartoDB/carto-ps-lib/blob/main/CONTRIBUTING.md) for detailed instructions.
9
+ ```bash
10
+ npm install --save @carto/ps-react-ui
11
+ ```
12
12
 
13
- ## Running Cosmos
13
+ ## Usage
14
14
 
15
- We use React Cosmos as a blank canvas for UI components development and testing.
15
+ The see what helpers are available, the interfaces and examples, see [docs](https://github.com/CartoDB/carto-ps-lib/blob/main/docs/modules/carto_ps_react_ui.md) section.
16
16
 
17
- To run Cosmos, you need to run the following command:
17
+ ## Contributing
18
18
 
19
- ```
20
- npm run ui:start
21
- ```
19
+ See [the contributing guide](https://github.com/CartoDB/carto-ps-lib/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started with our project.
22
20
 
23
- Open http://localhost:6006. You will see our UI components catalog!
21
+ If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/github/docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](https://github.com/CartoDB/carto-ps-lib/blob/main/CONTRIBUTING.md) for detailed instructions.