1.0.1 • Published 4 years ago
@bonitasoft/uid-textarea v1.0.1
\
Simple textarea (with label) web component.
(This webcomponent follows the open-wc recommendation)
➤ Using the component
Installation
npm i @bonitasoft/uid-textareaUsage
<script type="module">
import '@bonitasoft/uid-textarea/dist/uid-textarea.bundle.min.js';
</script>
<uid-textarea></uid-textarea>Attributes
| Attribute | Type | Default | Possible values |
|---|---|---|---|
id | string | "" | |
label | string | "Default label" | |
label-hidden | boolean | false | |
label-position | string | "top" | left top |
label-width | string | "4" | |
max-length | string | "" | |
min-length | string | "" | |
readonly | boolean | false | |
required | boolean | false | |
value | string | "" |
Events
| Event | Type |
|---|---|
valueChange | CustomEvent<string> |
➤ Developing the component
Linting and formatting
To scan the project for linting and formatting errors, run
npm run lintTo automatically fix linting and formatting errors, run
npm run formatTesting with Web Test Runner
To execute a single test run:
npm run testTo run the tests in interactive watch mode run:
npm run test:watchDemoing with Storybook
To run a local instance of Storybook for your component, run
npm run storybookTo build a production version of Storybook, run
npm run storybook:buildTooling 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 web-dev-server
npm startTo run a local development server that serves the basic demo located in demo/index.html
Publish npm package
To generate & test the web component bundle, and publish it:
npm run publish