This repo is no longer maintained or supported
(TODO: setup npm package location)
git clone [email protected]:wellcometrust/corporate-components.git
This repo supports a specific version of Node.js which is specified in .nvmrc. It is strongly recommended that you install NVM on your local machine to easily manage multiple versions of Node.
Running nvm use from the command line will automatically pick up the version named in the .nvmrc file and set this as the node version for the current terminal window.
npm install
In order to preview any code changes within another local project, a symlink needs to be setup for the corporate-components project. From the corporate-components root, run:
npm linkAssuming your consuming project and this repo are in the same folder, run the following command (or set it as an alias for convenience).
npm link @wellcometrust/corporate-components --legacy-peer-deps && cd ../corporate-components && npm link ../corporate-react/node_modules/react --legacy-peer-deps && cd ../corporate-react
See the following table for a breakdown of this script.
| Command | Description |
|---|---|
npm link @wellcometrust/corporate-components |
Link to the symlinked CC package from the consuming app |
--legacy-peer-deps |
Optional flag ignores dependency tree checks. This is bad practice in production environments as some dependency versions may not be supported by certain packages and cause issues. We only use it here to overcome dependency mismatches in Storybook which is not included in the production version of the package. |
cd ../corporate-components |
Switch to CC root folder |
npm link ../corporate-react/node_modules/react |
Link CC to the consuming app's version of React to avoid a hooks error |
cd ../corporate-react |
Switch back to consuming app root folder |
npm link will need to be rerun after any npm install operation.
Please note that corporate-components must first be compiled or built in order to use the compiled distributable files.
import { ComponentName } from '@wellcometrust/corporate-components';@import '@wellcometrust/corporate-components/dist/style.css';sudo npm linkWatch and compile files on change.
npm run devBuilds files for distribution.
npm run buildStorybook is a UI development environment we are using to preview and test our component library. Using Storybook allows us to work on components in isolation.
npm run storybookSeeing this error message?
Hooks can only be called inside the body of a function component.
This issue can be caused by npm link and the very nature of the symlinks which npm uses to create the links. Effectively React is flagging up a possible duplicate instance of React.
To get round this you will need to link to the app's instance of React by running the following command from the library root (assuming the library and app are in the same folder).
npm link ../corporate-react/node_modules/react