@salesforce-ux/c360-text-input

About

Inputs are the text boxes that allow users to input custom text entries with a keyboard.

Getting Started

Let's start by installing c360-text-input as a dependency of your project with npm.

npm i @salesforce-ux/c360-text-input

Distributable

After installation, all the distributables for the c360-text-input are found under @salesforce-ux/c360-text-input/dist/ folder.

| File Name | Description | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | text-input.css | The CSS file for c360-text-input component. | | text-input.js | The bundled JS file for c360-text-input component.This file is useful for Non LWC applications.(see below →) |

Integration

For the sake of understanding, we will categorize the development environment into LWC and Non LWC application.
This Guide will cover the integration approach for these two types of application.

For Lightning Web Component(LWC) Application

Dependency Inclusion

c360-styling-hooks is a styling dependency for c360-text-input. Hence, this needs to be embedded into your web app in order to make the c360-text-input render properly.

/* myComponent.css */
@import '@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css';

There are also other ways c360-styling-hooks can be embedded. Please checkout the c360-styling-hooks Integration Guide to learn more.

Component CSS Import

/* myComponent.css */
@import '@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css';
@import '@salesforce-ux/c360-text-input/dist/text-input.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.

<div part="input-text">
  <label part="label">
    <slot></slot>
  </label>
  <div part="input-container">
    <slot name="start"></slot>
    <input part="input" />
    <slot name="end"></slot>
  </div>
</div>
<slot name="help-text"></slot>

For Non LWC Application

Dependency Inclusion Read the section above

Component Import

/* myComponent.js */
import C360TextInput from '@salesforce-ux/c360-text-input/dist/text-input';

Component Registration

/* myComponent.js */
customElements.define('c360-text-input', C360TextInput);

Example

Below is one approach to integrate your c360-text-input component.

Script

/* myComponent.js */
import '@salesforce-ux/c360-styling-hooks/dist/hooks.custom-props.css';
import C360TextInput from '@salesforce-ux/c360-text-input/dist/text-input';
window.customElements.define('c360-text-input', C360TextInput);

HTML

<c360-text-input>
  Label
  <div slot="help-text">Help text goes here</div>
</c360-text-input>

Interactive Demo

To see more examples with interactive demo, please visit c360 Subsytem's Storybook Environment

Dependencies

This component imports the following dependencies.

• c360-icon

Accessibility

• All global aria-* attributes should follow all interaction requirements per the W3C.

• When interacting with the associated label via click, it should focus the related input.