merge: components package preparation, replace components on learn-example (#835)
* [#812,package][xl]: package preparation, replace components on learn-example * [#812,package][xs]: upgrade portaljs/components version on learn-example * [package][xs]: add deboundebinput back to lean-example
This commit is contained in:
@@ -1,32 +1,29 @@
|
||||
# `components` package
|
||||
# PortalJS React Components
|
||||
|
||||
**See live:** https://storybook.portaljs.org
|
||||
**Storybook:** https://storybook.portaljs.org
|
||||
**Docs**: https://portaljs.org/docs
|
||||
|
||||
## Usage
|
||||
|
||||
To install this package on your project:
|
||||
|
||||
```bash
|
||||
npm i @portaljs/components
|
||||
```
|
||||
|
||||
> Note: React 18 is required.
|
||||
|
||||
You'll also have to import the styles CSS file in your project:
|
||||
|
||||
```ts
|
||||
// E.g.: Next.js => pages/_app.tsx
|
||||
import '@portaljs/components/styles.css'
|
||||
```
|
||||
|
||||
## Dev
|
||||
|
||||
Use Storybook to work on components by running:
|
||||
|
||||
```bash
|
||||
yarn storybook
|
||||
npm run storybook
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
To build this project, run:
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
```
|
||||
|
||||
## Install
|
||||
|
||||
TODO: command to install the package
|
||||
|
||||
### Next.js
|
||||
|
||||
Add this line at the start of `_app.tsx`:
|
||||
|
||||
```ts
|
||||
// pages/_app.tsx
|
||||
import "dist/styles.css";
|
||||
```
|
||||
24752
packages/components/package-lock.json
generated
Normal file
24752
packages/components/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,11 +1,18 @@
|
||||
{
|
||||
"name": "components",
|
||||
"private": true,
|
||||
"version": "0.0.1",
|
||||
"name": "@portaljs/components",
|
||||
"version": "0.0.3",
|
||||
"type": "module",
|
||||
"description": "https://portaljs.org",
|
||||
"keywords": [
|
||||
"data portal",
|
||||
"data catalog",
|
||||
"table",
|
||||
"charts",
|
||||
"visualization"
|
||||
],
|
||||
"scripts": {
|
||||
"dev": "yarn storybook",
|
||||
"build": "tsc && vite build && yarn build-tailwind",
|
||||
"dev": "npm run storybook",
|
||||
"build": "tsc && vite build && npm run build-tailwind",
|
||||
"lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
|
||||
"prepack": "json -f package.json -I -e \"delete this.devDependencies; delete this.dependencies\"",
|
||||
"storybook": "storybook dev -p 6006",
|
||||
@@ -65,6 +72,12 @@
|
||||
".": {
|
||||
"import": "./dist/components.es.js",
|
||||
"require": "./dist/components.umd.js"
|
||||
},
|
||||
"./styles.css": {
|
||||
"import": "./dist/styles.css"
|
||||
}
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user