@granite-elements/granite-clipboard
v4.1.2
Published
A lightweight element wrapping-up clipboard.js
Downloads
94
Maintainers
Readme
<granite-clipboard>
A simple, lightweight element wrapping-up clipboard.js.
Built on lit-element following the open-wc recommendation.
The old Polymer 2.x-1.x version is available on the
polymer-hybrid-1.x-2.x
branch.
Installation
npm i granite-clipboard
Usage
<script type="module">
import 'granite-clipboard/granite-clipboard.js';
</script>
<granite-clipboard text="Text to be copied">
<div style="width:250px;height:50px;border-radius:5px;background-color:#aaaaff;cursor:pointer;">Click here</div>
</granite-clipboard>
Linting with ESLint, Prettier, and Types
To scan the project for linting errors, run
npm run lint
You can lint with ESLint and Prettier individually as well
npm run lint:eslint
npm run lint:prettier
To automatically fix many linting errors, run
npm run format
You can format using ESLint and Prettier individually as well
npm run format:eslint
npm run format:prettier
Testing with Karma
To run the suite of karma tests, run
npm run test
To run the tests in watch mode (for TDD, for example), run
npm run test:watch
Demoing with Storybook
To run a local instance of Storybook for your component, run
npm run storybook
To build a production version of Storybook, run
npm run storybook:build
Tooling configs
For most of the tools, the configuration is in the package.json
to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
Local Demo with es-dev-server
npm start
To run a local development server that serves the basic demo located in demo/index.html
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D