1.5.0 • Published 3 years ago

@valle/valle-select v1.5.0

Weekly downloads
8
License
MIT
Repository
github
Last release
3 years ago

valle-select

Awesome valle-select - Web Component using Polymer 3

npm Published on webcomponents.org

How to install and use:

1 - Install the element using Yarn:

$ yarn add @valle/valle-select

2 - Import the element:

<script type="module" src="node_modules/@valle/valle-select/valle-select.js"></script>

or in your javascript file

import "@valle/valle-select/valle-select.js";

3 - Start using it!

<valle-select label="Names" helpertext="Choose your name">
  <valle-option value="option 1">Example 1</valle-option>
  <valle-option value="option 2">Example 2</valle-option>
  <valle-option value="option 3">Example 3</valle-option>
</valle-select>

<valle-select>

Properties

PropertyTypeDefaultDescription
labelString""Default label
disabledBooleanfalseDisabled state
requiredBooleanfalseRequired validate
helpertextString""Description text for help
errortextString""Error message
placeholderString""Default placeholder
errorBooleanfalseError state
openBooleanfalseOpen state
autofocusBooleanfalseDefault autofocus
tooltipString""A tooltip for inputs
tooltipposString""Tooltip position (available: top-right)
tooltiplengthString""Tooltip length (available: small, medium and large)

Styling

The following custom properties and mixins are available for styling:

Custom propertyDefaultDescription
--valle-select-colorrgba(5, 159, 183, .87)Primary color
--valle-input-width100%Select width
--icon-tooltip-color#000Icon tooltip color

API

The following properties are available via javascript:

PropertyTypeDescription
valueStringSelected value from option content
data-valle-valueStringSelected value from option value
disabledBooleanDisabled state
optionsArrayAll valle-options available
openBooleanOpen state
errorBooleanError state
currentObjectSelected valle-options

<valle-option>

Properties

PropertyTypeDefaultDescription
selectedBooleanfalseSelected state
valueString""Default value

Browser Support

Using the webcomponents.js:

ChromeOperaFirefoxSafariIEEdge
Latest ✔Latest ✔Latest ✔Latest ✔11+Latest ✔

Development

1 - Verify if you have node and yarn installed.

2 - Install Polymer-CLI:

$ [sudo] yarn global add polymer-cli

3 - Install local dependencies:

$ yarn

4 - Start the development server:

$ yarn start

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our issues the next steps of the project ;) Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT License © valleweb

1.5.0

3 years ago

1.4.5

3 years ago

1.4.4

3 years ago

1.4.3

3 years ago

1.4.2

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.3.2

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.2

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.0.0

4 years ago