@trimble-oss/moduswebcomponents
Version:
Modus Web Components is a modern, accessible UI library built with Stencil JS that provides reusable web components following Trimble's Modus design system. This updated version focuses on improved flexibility, enhanced theming options, comprehensive cust
276 lines (270 loc) • 12.3 kB
JavaScript
import { withActions } from "@storybook/addon-actions/decorator";
import { html } from "lit";
import { ifDefined } from "lit/directives/if-defined.js";
import { createShadowHostClass } from "../../providers/shadow-dom/shadow-host-helper";
const meta = {
title: 'Components/Forms/Text Input',
component: 'modus-wc-text-input',
args: {
bordered: true,
disabled: false,
'include-clear': false,
'include-search': false,
inputmode: 'text',
label: 'Label',
size: 'md',
spellcheck: false,
type: 'text',
value: '',
},
argTypes: {
'auto-capitalize': {
options: ['off', 'none', 'on', 'sentences', 'words', 'characters'],
},
'auto-complete': {
control: { type: 'text' },
},
'auto-correct': {
options: ['on', 'off'],
},
enterkeyhint: {
options: ['enter', 'done', 'go', 'next', 'previous', 'search', 'send'],
},
feedback: {
description: 'Feedback prop for input components',
table: {
type: {
detail: `
Interface: IInputFeedbackProp
Properties:
- level ('error' | 'info' | 'success' | 'warning'): The feedback level
- message (string, optional): The feedback message
`,
},
},
},
inputmode: {
control: { type: 'select' },
options: [
'decimal',
'email',
'none',
'numeric',
'search',
'tel',
'text',
'url',
],
},
size: {
options: ['sm', 'md', 'lg'],
},
spellcheck: {
description: 'Whether the element may be checked for spelling errors. A hint for the browser, not a guarantee.',
table: {
category: 'attributes',
defaultValue: { summary: 'false' },
},
},
type: {
options: ['email', 'password', 'search', 'tel', 'text', 'url'],
},
},
decorators: [withActions],
parameters: {
actions: {
handles: ['clearClick', 'inputBlur', 'inputChange', 'inputFocus'],
},
},
};
export default meta;
const Template = {
render: (args) => html `
<modus-wc-text-input
aria-label="Text input"
auto-capitalize=${ifDefined(args['auto-capitalize'])}
auto-complete=${ifDefined(args['auto-complete'])}
auto-correct=${ifDefined(args['auto-correct'])}
?bordered=${args.bordered}
clear-aria-label=${ifDefined(args['clear-aria-label'])}
custom-class=${ifDefined(args['custom-class'])}
?disabled=${args.disabled}
enterkeyhint=${ifDefined(args.enterkeyhint)}
.feedback=${args.feedback}
include-clear=${ifDefined(args['include-clear'])}
include-search=${ifDefined(args['include-search'])}
input-aria-invalid=${ifDefined(args['input-aria-invalid'])}
input-id=${ifDefined(args['input-id'])}
inputmode=${ifDefined(args.inputmode)}
input-tab-index=${ifDefined(args['input-tab-index'])}
label=${ifDefined(args.label)}
max-length=${ifDefined(args['max-length'])}
min-length=${ifDefined(args['min-length'])}
name=${ifDefined(args.name)}
pattern=${ifDefined(args.pattern)}
placeholder=${ifDefined(args.placeholder)}
?read-only=${args['read-only']}
?required=${args.required}
size=${ifDefined(args.size)}
spellcheck=${ifDefined(args.spellcheck)}
type=${ifDefined(args.type)}
.value=${args.value}
></modus-wc-text-input>
`,
};
export const Default = Object.assign({}, Template);
const errorFeedback = {
level: 'error',
message: 'Value is required.',
};
export const WithErrorFeedback = {
// prettier-ignore
render: (args) => html `
<modus-wc-text-input
aria-label="Text input with error feedback"
.feedback=${errorFeedback}
id="error-input"
label=${ifDefined(args.label)}
?required=${true}
.value=${args.value}
></modus-wc-text-input>
<script>
// Adding this block to show how to set feedback via JS
//const input = document.getElementById('error-input');
//input.feedback = { level: 'error', message: 'Value is required.' };
</script>
`,
};
export const WithCustomIconSlot = {
// prettier-ignore
render: (args) => html `
<modus-wc-text-input
aria-label="Text input with custom icon"
auto-capitalize=${ifDefined(args['auto-capitalize'])}
auto-complete=${ifDefined(args['auto-complete'])}
auto-correct=${ifDefined(args['auto-correct'])}
?bordered=${args.bordered}
clear-aria-label=${ifDefined(args['clear-aria-label'])}
custom-class=${ifDefined(args['custom-class'])}
?disabled=${args.disabled}
enterkeyhint=${ifDefined(args.enterkeyhint)}
.feedback=${args.feedback}
include-clear=${ifDefined(args['include-clear'])}
include-search=${ifDefined(args['include-search'])}
input-id=${ifDefined(args['input-id'])}
inputmode=${ifDefined(args.inputmode)}
input-tab-index=${ifDefined(args['input-tab-index'])}
label=${ifDefined(args.label)}
max-length=${ifDefined(args['max-length'])}
min-length=${ifDefined(args['min-length'])}
name=${ifDefined(args.name)}
pattern=${ifDefined(args.pattern)}
placeholder=${ifDefined(args.placeholder)}
?read-only=${args['read-only']}
?required=${args.required}
size=${ifDefined(args.size)}
spellcheck=${ifDefined(args.spellcheck)}
type=${ifDefined(args.type)}
.value=${args.value}
>
<modus-wc-icon slot="custom-icon" name="heart" size="sm"></modus-wc-icon>
</modus-wc-text-input>
`,
args: {
placeholder: 'Enter text here...',
},
};
export const ShadowDomParent = {
render: (args) => {
// Create a unique shadow host for text-input component
if (!customElements.get('text-input-shadow-host')) {
const TextInputShadowHost = createShadowHostClass({
componentTag: 'modus-wc-text-input',
propsMapper: (v, el) => {
const textInputEl = el;
textInputEl.autoCapitalize = v['auto-capitalize'] || '';
textInputEl.autoComplete = v['auto-complete'] || '';
textInputEl.autoCorrect = v['auto-correct'] || '';
textInputEl.bordered = Boolean(v.bordered);
textInputEl.clearAriaLabel =
v['clear-aria-label'] || '' || 'Clear text';
textInputEl.customClass = v['custom-class'] || '';
textInputEl.disabled = Boolean(v.disabled);
textInputEl.enterkeyhint = v.enterkeyhint || '';
textInputEl.includeClear = Boolean(v['include-clear']);
textInputEl.includeSearch = Boolean(v['include-search']);
textInputEl.inputId = v['input-id'] || '';
textInputEl.inputTabIndex = v['input-tab-index'] || 0;
textInputEl.label = v.label || '';
textInputEl.maxLength = v['max-length'];
textInputEl.minLength = v['min-length'];
textInputEl.name = v.name || '';
textInputEl.pattern = v.pattern || '';
textInputEl.placeholder = v.placeholder || '';
textInputEl.readOnly = Boolean(v['read-only']);
textInputEl.required = Boolean(v.required);
textInputEl.size = v.size || '';
textInputEl.type = v.type || '';
textInputEl.value = v.value;
},
});
customElements.define('text-input-shadow-host', TextInputShadowHost);
}
return html `<text-input-shadow-host
.props=${Object.assign({}, args)}
></text-input-shadow-host>`;
},
};
export const Migration = {
parameters: {
docs: {
description: {
story: `
#### Breaking Changes
- In 1.0 input state was maintained by the component. 2.0 components encourage users to follow a controlled
input model. See the Form Inputs [documentation]([Angular](?path=/docs/documentation-form-inputs--docs) for
additional info and examples.
- Size values have changed from verbose names (\`small\`, \`medium\`, \`large\`) to abbreviations (\`sm\`, \`md\`, \`lg\`).
#### Prop Mapping
| 1.0 Prop | 2.0 Prop | Notes |
|------------------------------|---------------------|-------------------------------------------------------------|
| aria-label | aria-label | |
| autocapitalize | auto-capitalize | |
| autocorrect | auto-correct | |
| autocomplete | autocomplete | |
| auto-focus-input | autofocus | |
| clearable | include-clear | |
| disabled | disabled | |
| enter-key-hint | enterkeyhint | |
| error-text | feedback.message | Use \`feedback\` level |
| helper-text | | Not carried over |
| include-error-icon | | Not carried over |
| include-search-icon | include-search | |
| include-password-text-toggle | | Not carried over |
| inputmode | inputmode | |
| label | label | |
| max-length | max-length | |
| pattern | pattern | |
| placeholder | placeholder | |
| read-only | read-only | |
| required | required | |
| size | size | \`small\` → \`sm\`, \`medium\` → \`md\`, \`large\` → \`lg\` |
| spellcheck | spellcheck | |
| text-align | | Not carried over, use CSS instead |
| type | type | |
| valid-text | feedback.message | Use \`feedback\` level |
| value | value | |
#### Event Mapping
| 1.0 Event | 2.0 Event | Notes |
|-------------|-------------|------------------|
| valueChange | inputChange | |
`,
},
},
// To hide the actual story rendering and only show docs:
controls: { disable: true },
canvas: { disable: true },
},
// Simple render function or leave it empty
render: () => html `<div></div>`,
};