Function: shield()

Call Signature

function shield(content: ShieldContent): ContainerElement;

Defined in: src/UI/blocks/shield.tsx:36

Shield component providing protective overlay for UI elements. Blocks user interaction with underlying content.

Parameters

Parameter	Type	Description
content	ShieldContent	Content to display when first parameter is options object

Returns

ContainerElement

Example

Basic usage with overlay

shield(
  {overlay: true},
  [
    headerBar({title: 'Protected Content'}),
    group([
      text({text: 'This content is protected by a shield'}),
    ]),
  ]
);

Remarks

The default width is the same as bubble container (350px).

Call Signature

function shield(options: ShieldOptions, content: ShieldContent): ContainerElement;

Defined in: src/UI/blocks/shield.tsx:37

Shield component providing protective overlay for UI elements. Blocks user interaction with underlying content.

Parameters

Parameter	Type	Description
options	ShieldOptions	-
content	ShieldContent	Content to display when first parameter is options object

Returns

ContainerElement

Example

Basic usage with overlay

shield(
  {overlay: true},
  [
    headerBar({title: 'Protected Content'}),
    group([
      text({text: 'This content is protected by a shield'}),
    ]),
  ]
);

Remarks

The default width is the same as bubble container (350px).