npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nice-digital/nds-form-group

v4.0.12

Published

Form group component for the NICE Design System

Downloads

750

Readme

@nice-digital/nds-form-group

Form Group component for the NICE Design System

Installation

Install Node, and then:

npm i @nice-digital/nds-form-group --save

Usage

React

Import the FormGroup component from the package and use within JSX:

import React from "react";
import { FormGroup } from "@nice-digital/nds-form-group";

<FormGroup
	legend="How would you like us to contact you?"
	name="contact-preference"/>
	// pass in children as required
	<Radio label="Telephone" />
	<Radio label="Email" />
	// ---
</FormGroup>

Note: The React component automatically imports the SCSS, so there's no need to import the SCSS directly yourself.

Props

children
  • Type: React.node (required)

Pass through the child components that should be enclosed by the fieldset.

<FormGroup>
	<Radio value="yes" />
	<Radio value="no" />
</FormGroup>
legend
  • Type: string

The legend for the fieldset tag. If not supplied, styling for the visual box that wraps the fieldset won't be applied.

<FormGroup legend="Would you like us to contact you in the future?">
	<Radio value="yes" />
	<Radio value="no" />
</FormGroup>
name
  • Type: string

The name attribute that will be passed down to the child inputs. Name attributes are then not required for the child components directly.

<FormGroup
	legend="Would you like us to contact you in the future?"
	name="contact-permission"
>
	<Radio value="yes" />
	<Radio value="no" />
</FormGroup>
inline
  • Type: boolean

If supplied, the inline attribute will be passed down to children to apply the styling for left-to-right inline form inputs.

<FormGroup inline>
	<Radio value="yes" />
	<Radio value="no" />
</FormGroup>
hint
  • Type: string

Any hint or help text that should be rendered beneath the legend but above the inputs.

<FormGroup hint="We promise not to contact you too frequently!">
	<Radio value="yes" />
	<Radio value="no" />
</FormGroup>
groupError
  • Type: boolean

Render styled error text below the legend and above the inputs. Use the error attribute on the child components for additional error information specific to a single input.

<FormGroup groupError="Please choose at least one contact method.">
	<Checkbox value="email" />
	<Checkbox value="telephone" />
</FormGroup>
<FormGroup groupError="Please choose at least one contact method.">
	<Checkbox value="email" />
	<Checkbox value="telephone" error="Telephone is not available at this time" />
</FormGroup>

SCSS

If you're not using React, then import the SCSS directly into your application by:

@forward '@nice-digital/nds-form-group/scss/form-group';

HTML

If you're not using React, then include the SCSS as above and use the HTML:

Legend example:

<fieldset class="form-group">
	<legend class="form-group__legend">
		Are you happy for us to contact you in the future?
	</legend>
	<input type="checkbox" />
</fieldset>

Error example:

<fieldset class="form-group">
	<legend class="form-group__legend">
		Are you happy for us to contact you in the future?
	</legend>
	<p class="form-group__error-message">
		Please choose at least one contact method
	</p>
	<input type="checkbox" />
</fieldset>

Hint example:

<fieldset class="form-group">
	<legend class="form-group__legend">
		Are you happy for us to contact you in the future?
	</legend>
	<p class="form-group__hint">We promise not to contact you too often!</p>
	<p class="form-group__error-message">
		Please choose at least one contact method
	</p>
	<input type="checkbox" />
</fieldset>