@tigerconnect/web-component-library
Advanced tools
Comparing version 1.1.3 to 1.2.0
export * from './types'; | ||
import Avatar from './components/Avatar'; | ||
import Button from './components/Button'; | ||
@@ -7,2 +8,2 @@ import Modal from './components/Modal'; | ||
import Setting from './components/Setting'; | ||
export { Button, Card, Modal, Setting, Switch }; | ||
export { Avatar, Button, Card, Modal, Setting, Switch }; |
@@ -11,1 +11,6 @@ export declare type Colors = 'primary' | 'secondary' | 'success' | 'danger' | 'patient'; | ||
export declare type ModalSizes = 'large' | 'medium-large' | 'medium' | 'medium-small' | 'small-medium' | 'small'; | ||
export declare type AvatarSizes = 'small' | 'medium' | 'large' | 'xlarge'; | ||
export declare type AvatarTypes = 'team' | 'tag' | 'role' | 'myroles' | 'initials' | 'image'; | ||
export declare type AvatarShapes = 'squircle' | 'circle'; | ||
export declare type AvatarThemes = 'default' | 'empty'; | ||
export declare type AvatarInitialsThemes = 'team' | 'user'; |
{ | ||
"name": "@tigerconnect/web-component-library", | ||
"version": "1.1.3", | ||
"version": "1.2.0", | ||
"description": "a shared component library for tc projects", | ||
@@ -9,7 +9,9 @@ "main": "lib/index.esm.js", | ||
"scripts": { | ||
"storybook": "start-storybook -p 6006", | ||
"build": "rm -rf ./lib/* && rollup -c", | ||
"build-storybook": "build-storybook", | ||
"test": "echo \"Error: no test specified\" && exit 1", | ||
"deploy": "npm run build; npm publish" | ||
"deploy": "run-p deploy:library deploy:storybook", | ||
"deploy:library": "npm run build && npm publish", | ||
"deploy:storybook": "npm run build-storybook && gh-pages -d storybook-static", | ||
"storybook": "start-storybook -p 6006", | ||
"test": "echo \"Error: no test specified\" && exit 1" | ||
}, | ||
@@ -52,2 +54,4 @@ "author": "", | ||
"framer-motion": "^6.2.8", | ||
"gh-pages": "^3.2.3", | ||
"npm-run-all": "^4.1.5", | ||
"postcss-custom-properties": "^12.1.5", | ||
@@ -54,0 +58,0 @@ "postcss-preset-env": "^7.4.2", |
# Web Component Library | ||
## About this project | ||
- Developed with [Storybook](https://storybook.js.org/) | ||
- Bundled with [rollup.js](https://rollupjs.org/) | ||
## Development Setup | ||
@@ -9,17 +14,33 @@ | ||
locally | ||
4. `npm run deploy` to build and publish the library to NPM. See [Publishing](#publishing) for more | ||
details. | ||
4. `npm run deploy` to build and publish the library to NPM and Storybook application to GitHub | ||
Pages. See [Publishing](#publishing) for more details. | ||
## Using the library in a project locally | ||
1. In the project folder, run `npm install <location of web-component-library>` | ||
2. Update your webpack/craco config alias to use | ||
``` | ||
react: path.resolve('./node_modules/react') | ||
``` | ||
to ensure that the library uses the project's React path, and not its own. | ||
The current solution for this is not pretty, but it'll suffice: | ||
You'll want to leave the updated package's local route in package.json out of your commits, as this | ||
will break deployments to other environments. | ||
1. In the project folder, run `npm i <location of web-component-library>` | ||
2. Rename the react folder within web-component-library's node_modules to avoid it being used | ||
### Important! | ||
Remember to keep these changes out of your commits, as this will break deployments to other | ||
environments. | ||
## VSCode Setup | ||
This project uses PostCSS, which will require a few things so that your CSS files will be understood | ||
and formatted auto-correctly: | ||
Include in your VSCode editor settings (JSON): | ||
``` | ||
"files.associations": { | ||
"*.css": "scss" | ||
} | ||
"editor.codeActionsOnSave": { | ||
"source.fixAll.stylelint": true | ||
} | ||
``` | ||
## Publishing | ||
@@ -30,17 +51,18 @@ | ||
2. Run `npm run deploy`. The command will run `npm run build` and then `npm publish`. | ||
- This command will also build and deploy the latest Storybook application to | ||
[GitHub Pages](https://tigertext.github.io/web-component-library/). | ||
3. Update any repo using this package to have the newly published version and reinstall | ||
respectively. | ||
## VSCode Setup | ||
## Storybook Deployment | ||
This project uses PostCSS, which will require a few things so that your CSS files will be understood | ||
and formatted auto-correctly: | ||
We currently deploy three different versions of Storybook to help facilitate sharing changes during | ||
different development phases. | ||
1. Install https://marketplace.visualstudio.com/items?itemName=csstools.postcss | ||
2. Include in your VSCode editor settings: | ||
``` | ||
"editor.codeActionsOnSave": { | ||
"source.fixAll.stylelint": true | ||
} | ||
``` | ||
1. https://tigertext.github.io/web-component-library/ holds the production version and is deployed | ||
when publishing the library to NPM with `npm run deploy`. | ||
2. https://login.tigerconnect.xyz/app/components/ holds the latest pre-release version (or is in | ||
sync with the production version) and is deployed when the master branch is updated. | ||
3. https://login.tigerconnect.xyz/feature/FEATURE_BRANCH_NAME/app/components holds your development | ||
changes and is deployed when your feature branch is updated. | ||
- Ex: https://login.tigerconnect.xyz/feature/oasis-877-gh-pages/app/components/ |
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
157659
25
742
67
52
25