Tradeshift

Elements

Reusable Tradeshift UI Components as Web Components https://tradeshift.github.io/elements

NPM Version Downloads per month Contributors
Closed issues Open issues Open pull requests Closed pull requests Last commit

## ➤ How to use it - Install the core package of the Elements ```shell $ npm i @tradeshift/elements --save ``` - Install the package of the component you need ([available components](https://github.com/Tradeshift/elements/tree/master/packages/components)) ```shell $ npm i @tradeshift/elements.button --save ``` - Import the component ```js import '@tradeshift/elements.button'; ``` or ```html ``` - Import the css variables ```js import '@tradeshift/elements/src/vars.css'; ``` or ```html ``` - Use it ```html Sample Button ``` - Our components rely on having the `Open Sans` available, You can see the `font-weight` and `font-style` you need to load [here](https://github.com/Tradeshift/elements/blob/master/packages/core/src/fonts.css), or you can just load it from our package (for now) ```html ``` ## ➤ Polyfills For supporting IE11 you need to do couple of more things - If you are using the [Tradeshift-ui](https://github.com/Tradeshift/tradeshift-ui) you need to upgrade it to a compatible version: - For version `12` you should upgrade to `12.2.9` or newer version - For version `11` you should upgrade to `11.3.2` or newer version - Don't shim CSS Custom Properties in IE11 ```html ``` ##### You have two options for polyfills library: 1. Use [`@open-wc/polyfills-loader`](https://github.com/open-wc/open-wc/tree/master/packages/polyfills-loader) - Installation ```shell $ npm i @open-wc/polyfills-loader ``` - Load it ```js import loadPolyfills from '@open-wc/polyfills-loader'; loadPolyfills().then(() => import('./my-app.js')); ``` 2. Use [`@webcomponents/webcomponentsjs`](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs) - Installation ```shell $ npm i @webcomponents/webcomponentsjs --save ``` - Enable ES5 class-less Custom Elements ```html ``` - Load appropriate polyfills and shims with [`@webcomponents/webcomponentsjs`](https://github.com/webcomponents/webcomponentsjs) ```html ``` - Load the core and components scripts after `WebComponensReady` event: ```html ``` ## ➤ How to run it - Make sure your node version is > 10. If you are using `nvm` you can just run: ```shell $ nvm use ``` - We are using [lerna](https://github.com/lerna/lerna) to manage our components in single repo but their own packages, so for installation you need to run: ```shell $ npx lerna bootstrap # bootstrap all packages and make sure they work together ``` - You can start the development server which is watching for changes: ```shell $ npm start ``` - Open [http://127.0.0.1:8080/](http://127.0.0.1:8080/), or e.g. http://127.0.0.1:8080/packages/components/{PACKAGE_NAME}/ if you want to test a specific element and that element (PACKAGE_NAME) has got an `index.html` file. If not, feel free to add one. Example: [http://127.0.0.1:8080/packages/components/action-select/](http://127.0.0.1:8080/packages/components/action-select/) ## ➤ How to contribute Thanks for your interest and help! - First thing you need to do is read this [[Component Checklist](https://github.com/Tradeshift/elements/wiki/Component-checklist)] which contains lots of important information about what you need to consider when you are creating/changing components ##### [General info](https://github.com/Tradeshift/elements/wiki/Useful-materials-starter) You can find some [links to useful materials](https://github.com/Tradeshift/elements/wiki/Useful-materials-starter) about what we are using and some tutorials and articles that can help you get started. #### `ts.elements`-specific info - Extend `TSElement`, instead of `LitElement` - Import `css`, `unsafeCSS` & `html` from `@tradeshift/elements` instead of `lit-html` - Add the UMD global namespace to [`rollup.globals.json`](https://github.com/Tradeshift/elements/blob/master/rollup.globals.json) - Add your package to the [`package.json`](<(https://github.com/Tradeshift/elements/blob/master/package.json)>) dependencies ## ➤ How to create new component To make it simpler and more consistent, we added a `Component generator`, You can use our its script to generate a new component from terminal and it will create the component inside `packages/components` - **NOTE**: Still you need to add the UMD global namespace to [`rollup.globals.json`](https://github.com/Tradeshift/elements/blob/master/rollup.globals.json) and add your package to the [`package.json`](<(https://github.com/Tradeshift/elements/blob/master/package.json)>) dependencies, for now ```shell $ npm run component-gen ``` ## ➤ How to release We are using [lerna to publish](https://github.com/lerna/lerna/tree/main/commands/version#readme) our elements - Checkout a master branch. - Run `npm run new-version` for a stable release, or `npm run new-version:beta` for a beta release. It will invoke a shell script that: - calculate a new version number (`new-version:beta` creates or increments a `-beta.N` version, e.g. `0.41.1-beta.0`; `new-version` graduates a current beta to its stable version, e.g. `0.41.1-beta.1` to `0.41.1`) - create a new branch with new version number and a new git tag - generate CHANGELOG.md for all components - make a commit with a predefined commit message to created branch - push this branch and git tag to origin (set `RELEASE_REMOTE=` if your `origin` is a fork) - Go to Github and create a PR from the branch created at previous step. Merge it with a merge commit (not squash), so the pushed tag stays on master. - After merge a new version of elements will be built and published: stable versions to NPM registry and Github Packages with the `latest` dist-tag; beta versions to Github Packages only, with the `beta` dist-tag (`npm install @tradeshift/elements@beta --registry=https://npm.pkg.github.com`). - If a beta needs fixes, merge them to master with normal PRs and release the next beta (`npm run new-version:beta`) or the stable version (`npm run new-version`). - Prerelease versions must start with a letter after the `-` (`-beta.0`, not `-0`): lerna treats a prerelease id of `0` as stable and would publish it as `latest`. ## ➤ How to test a PR before it's merged Comment on the PR to publish a temporary preview version to GitHub Packages (restricted to Tradeshift org members / the repo owner): - `npm publish` — builds and publishes **every** package with the same `0.0.0-` version, under the `pr-preview` dist-tag. Package dependencies between them (e.g. `@tradeshift/elements.header`'s dependency on `@tradeshift/elements.app-icon`) are automatically rewritten to match. - `npm publish ` — publishes only that one package, e.g. `npm publish app-icon` (`npm publish core` or `npm publish elements` for `@tradeshift/elements` itself). Use this only when nothing that package depends on changed — it does not rewrite that package's own dependency ranges, so a change in a dependency won't be reflected unless that dependency is also published (with `npm publish` or its own `npm publish `). - The bot replies with the exact `npm install ... --registry=https://npm.pkg.github.com` command(s) to try it out. --- ## ➤ [Polyfill Limitations](https://github.com/Tradeshift/elements/wiki/Polyfill-Limitations) You can see a list of limitations that we should watch out for, [here](https://github.com/Tradeshift/elements/wiki/Polyfill-Limitations) ## ➤ License - You can always create forks on GitHub, submit Issues and Pull Requests. - You can only use Tradeshift Elements to make apps on a Tradeshift platform, e.g. tradeshift.com. - You can fix a bug until the bugfix is deployed by Tradeshift. - You can host Tradeshift Elements yourself. - If you want to make a bigger change or just want to talk with us, reach out to our team here on GitHub. You can read the full license agreement in the [LICENSE.md](https://github.com/Tradeshift/elements/blob/master/LICENSE.md).