@salesforce-ux/wes-input-radio
v0.1.1
Published
A radio allows the user to choose only one of a predefined set of mutually exclusive options.
Downloads
5
Readme
@salesforce-ux/wes-input-radio
About
A radio button allows the user to choose only one of a predefined set of mutually exclusive options.
Getting Started
Let's start by installing wes-input-radio as a dependency of your project with npm.
npm i @salesforce-ux/wes-input-radioDistributable
After installation, all the distributable's for the wes-input-radio are found under /node_modules/@salesforce-ux/wes-input-radio/dist/ folder.
|File Name |Description |
|- |- |
|input-radio.css |The CSS file specific to wes-input-radio only.|
|input-radio.compiled.css |The Compiled CSS file for wes-input-radio. This file includes styles of wes-input-radio. This file is useful for LWC applications.(see below →)|
|input-radio.js |The bundled JS file for wes-input-radio component. This file is useful for Non LWC applications.(see below →)|
wes-input-radio Integration
For the sake of understanding, we have categorized the development environment into LWC and Non LWC application. If you are using the Salesforce Experience Cloud platform, WES is supported through an Unlocked Package, see the Confluence page for the WES Unlocked Package.
This Guide covers the integration approach for these two types of application.
For Lightning Web Component(LWC) Application
Dependency Inclusion
wes-styling-hooks is a styling dependency for wes-input-radio. Hence, this needs to be embedded into the root of the web app in order to make the wes-input-radio render properly.
<html>
<head>
<link rel="stylesheet" href="/node_modules/@salesforce-ux/wes-styling-hooks/dist/hooks.custom-props.css">
<!-- Your application's other stylesheets go below -->
<link rel="stylesheet" href="...">
</head>
<body>
<!-- Your application -->
</body>
</html>There are also other ways wes-styling-hooks can be embedded. Please checkout the wes-styling-hooks Integration Guide to learn more.
Component CSS Import
/* myComponent.css */
@import '@salesforce-ux/wes-input-radio/dist/input-radio.compiled.css'HTML Decoration
After that,the HTML of your LWC component template needs to be decorated to have all the named part attributes as per the component's specification. Below is a reference to the component's structure.
<wes-input-radio>
<div part="input-radio">
<input type="radio" id="radio-id" part="radio" />
<label part="label" for="radio-id">
<span part="indicator"></span>
<slot></slot>
</label>
</div>
</wes-input-radio>For Non LWC Application
Dependency Inclusion Read the section above
Component Import
/* myComponent.js */
import WESInputRadio from '@salesforce-ux/wes-input-radio/dist/input-radio';Component Registration
/* myComponent.js */
customElements.define('wes-input-radio', WESInputRadio);Example
Below is one approach to integrate your wes-input-radio component.
Script
/* myComponent.js */
import '@salesforce-ux/wes-styling-hooks/dist/hooks.custom-props.css';
import WESInputRadio from '@salesforce-ux/wes-input-radio/dist/input-radio';
window.customElements.define('wes-input-radio', WESInputRadio);HTML
<wes-input-radio>Radio</wes-input-radio>Interactive Demo
To see more examples with interactive demo, please visit WES Subsystem's Storybook Environment