Skip to main content

ConsentCheckbox

Requires enabling of the sms_marketing capability of the Customer Privacy capability group to work.

Use buyer consent checkboxes for collecting the buyer’s approval for a given policy.

Anchor to propertiesProperties

Anchor to accessibilityLabel
accessibilityLabel
string

A label used for users using assistive technologies like screen readers. When set, any children or label supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers.

Anchor to checked
checked
boolean
Default: false

Whether the control is active.

Anchor to command
command
'--auto' | '--show' | '--hide' | '--toggle'
Default: '--auto'

Sets the action the commandFor should take when this clickable is activated.

See the documentation of particular components for the actions they support.

  • --auto: a default action for the target component.
  • --show: shows the target component.
  • --hide: hides the target component.
  • --toggle: toggles the target component.
  • --copy: copies the target ClipboardItem.
Anchor to commandFor
commandFor
string

ID of a component that should respond to activations (e.g. clicks) on this component.

See command for how to control the behavior of the target.

Anchor to defaultChecked
defaultChecked
boolean
Default: false

Whether the control is active by default.

Anchor to disabled
disabled
boolean
Default: false

Disables the control, disallowing any interaction.

Anchor to error
error
string

Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

Anchor to id
id
string

A unique identifier for the element.

Anchor to label
label
string

Visual content to use as the control label.

Anchor to name
name
string

An identifier for the control that is unique within the nearest containing Form component.

Anchor to policy
policy

The policy for which user consent is being collected for.

sms-marketing: Represents the policy for SMS marketing consent.

Anchor to value
value
string

The value used in form data when the control is checked.

Was this section helpful?

Anchor to eventsEvents

Anchor to change
change
((event: <typeof tagName>) => void) | null

A callback that is run whenever the control is changed.

Was this section helpful?

Code

<s-consent-checkbox
defaultChecked
label="Text me with news and offers"
policy="sms-marketing"
></s-consent-checkbox>

Preview