@bonitasoft/uid-text

<uid-text>

Simple text (with label) web component.

(This webcomponent follows the open-wc recommendation)

➤ Using the component

Installation

npm i @bonitasoft/uid-text

Usage

<script type="module">
  import '@bonitasoft/uid-text/dist/uid-text.bundle.min.js';
</script>

<uid-text></uid-text>

Attributes

Attribute	Type	Default	Possible values
alignment	string	"left"	left center right
allow-html	boolean	false
id	string	""
label	string	""
label-hidden	boolean	false
label-position	string	"top"	left top
label-width	number	4
text	string	""

Note: If allow-html is set, this is unsafe to use the text attribute with any user-provided input that hasn't been sanitized or escaped, as it may lead to cross-site-scripting vulnerabilities.

➤ Developing the component

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Testing with Web Test Runner

To execute a single test run:

npm run test

To run the tests in interactive watch mode 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 web-dev-server

npm start

To 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