JSPM

@vaadin/vaadin-radio-button

2.0.0-alpha1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12098
  • Score
    100M100P100Q150442F
  • License Apache-2.0

vaadin-radio-button

Package Exports

  • @vaadin/vaadin-radio-button
  • @vaadin/vaadin-radio-button/vaadin-radio-button
  • @vaadin/vaadin-radio-button/vaadin-radio-button.js
  • @vaadin/vaadin-radio-button/vaadin-radio-group
  • @vaadin/vaadin-radio-button/vaadin-radio-group.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vaadin/vaadin-radio-button) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

<vaadin-radio-button>

<vaadin-radio-button> is a Web Component providing an accessible and customizable radio button, part of the Vaadin components.

Live Demo ↗ | API documentation ↗

npm version Published on webcomponents.org Build Status Coverage Status Gitter Published on Vaadin  Directory Stars on vaadin.com/directory

⚠️ This is a pre-release version built with LitElement, part of the next generation of Vaadin web components.

Looking for Vaadin 14 compatible version? Please see the following branches:

<vaadin-radio-group name="radio-group" value="bar">
  <vaadin-radio-button value="foo">Foo</vaadin-radio-button>
  <vaadin-radio-button value="bar">Bar</vaadin-radio-button>
  <vaadin-radio-button value="baz">Baz</vaadin-radio-button>
</vaadin-radio-group>

Screenshot of vaadin-radio-group

Installation

Install vaadin-radio-button:

npm i @vaadin/vaadin-radio-button --save

Once installed, import it in your application:

import '@vaadin/vaadin-radio-button/vaadin-radio-button.js';

Getting started

Vaadin components use the Lumo theme by default.

To use the Material theme, import the correspondent file from the theme/material folder.

Entry points

  • The components with the Lumo theme:

    theme/lumo/vaadin-radio-button.js theme/lumo/vaadin-radio-group.js

  • The components with the Material theme:

    theme/material/vaadin-radio-button.js theme/material/vaadin-radio-group.js

  • Alias for theme/lumo/vaadin-radio-button.js theme/lumo/vaadin-radio-group.js:

    vaadin-radio-button.js vaadin-radio-group.js

Running demos and API docs in a browser

  1. Fork the vaadin-radio-button repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vaadin-radio-button directory, run npm install to install dependencies.

  4. Run npm start, browser will automatically open the component API documentation.

Running tests from the command line

  • When in the vaadin-radio-button directory, run npm test

  • To debug tests in the browser, run npm run test:debug

Following the coding style

We are using ESLint for linting TypeScript code. You can check if your code is following our standards by running npm run lint, which will automatically lint all .ts files.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2.0

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.