Flag group

A flag group is used to group a set of related flags, with entry and exit animations.

Examples Code Changelog

Props

`children`
Description	Flag elements to be displayed.
Type	`boolean \| ReactElement<any, string \| React.JSXElementConstructor<any>> \| ReactElement<any, string \| React.JSXElementConstructor<any>>[]`

`id`
Description	ID attribute used for DOM selection.
Type	`string`

`label`
Description	Describes the specific role of this FlagGroup for users viewing the page with a screen reader (defaults to `Flag notifications`).
Type	`string`

`labelTag`
Description	Describes the specific tag on which the screen reader text will be rendered (defaults to `h2`).
Type	`"symbol" \| "object" \| "cite" \| "data" \| "form" \| "label" \| "pattern" \| "span" \| "summary" \| "slot" \| "style" \| "title" \| "a" \| "abbr" \| "address" \| "area" \| "article" \| "aside" \| ... 160 more ... \| React.ComponentType<...>`

`onDismissed`
Description	Handler which will be called when a Flag's dismiss button is clicked. Receives the id of the dismissed Flag as a parameter.
Type	`(id: string \| number, analyticsEvent: UIAnalyticsEvent) => void`

`shouldRenderToParent`
Description	Controls whether the flag group is rendered inline within its parent component or in a portal at the document root. `true` renders the flag group in the DOM node closest to the trigger `false` renders the flag group in React.Portal Defaults to `false`.
Type	`boolean`

Was this page helpful?

We use this feedback to improve our documentation.