lion/packages/fieldset
Thomas Allmer bcd074d1fb feat: use markdown javascript (mdjs) for documentation
Co-authored-by: CubLion <alex.ghiu@ing.com>
2020-05-29 17:01:15 +02:00
..
docs/helpers feat: use markdown javascript (mdjs) for documentation 2020-05-29 17:01:15 +02:00
src feat(fieldset): add clearGroup method (#723) 2020-05-27 10:43:16 +02:00
test feat(fieldset): add clearGroup method (#723) 2020-05-27 10:43:16 +02:00
CHANGELOG.md chore: release new versions 2020-05-27 08:46:34 +00:00
index.js feat: api normalisation formElements and values 2020-02-20 14:17:13 +01:00
lion-fieldset.js feat: release inital public lion version 2019-04-26 10:37:57 +02:00
package.json chore: release new versions 2020-05-27 08:46:34 +00:00
README.md feat: use markdown javascript (mdjs) for documentation 2020-05-29 17:01:15 +02:00

Fieldset

lion-fieldset groups multiple input fields or other fieldsets together.

import { html } from 'lit-html';
import '@lion/input/lion-input.js';
import { localize } from '@lion/localize';
import { loadDefaultFeedbackMessages, MinLength, Validator, Required } from '@lion/validate';
import './lion-fieldset.js';
import './docs/helpers/demo-fieldset-child.js';

export default {
  title: 'Forms/Fieldset/Overview',
};

We have three specific fieldset implementations:

export const main = () => html`
  <lion-fieldset name="nameGroup" label="Name">
    <lion-input name="FirstName" label="First Name"></lion-input>
    <lion-input name="LastName" label="Last Name"></lion-input>
  </lion-fieldset>
`;

A native fieldset element should always have a legend-element for a11y purposes. However, our fieldset element is not native and should not have a legend-element. Our fieldset instead has a label attribute or you can add a label with a div- or heading-element using slot="label".

Live Demo/Documentation

See our storybook for a live demo and documentation

Features

  • Easy retrieval of form data based on field names
  • Advanced user interaction scenarios via interaction states
  • Can have validate on fieldset level and shows the validation feedback below the fieldset
  • Can disable input fields on fieldset level
  • Accessible out of the box

How to use

Installation

npm i --save @lion/fieldset
import { LionFieldset } from '@lion/fieldset';
// or
import '@lion/fieldset/lion-fieldset.js';

Example

<lion-fieldset name="personalia" label="personalia">
  <lion-input name="title" label="Title"></lion-input>
</lion-fieldset>

For more examples please look at Fieldset Examples.