Interface: ContextualHelpProps

Defined in: composites/ContextualHelp/ContextualHelp.tsx:46

Props for the ContextualHelp composite.

Deliberately a narrow surface over the two components it composes: the open state, the placement, and the trigger's emphasis. Anything past that is a sign the caller wants a different trigger or a different surface — compose PopoverTrigger + ActionButton + Popover directly then.

Properties

aria-label

aria-label: string

Defined in: composites/ContextualHelp/ContextualHelp.tsx:55

Accessible name for the trigger — required, and supplied already localized (fsl-ui never depends on an i18n runtime, ADR-001).

There is no default: the reference system falls back to a translated "Help", which it can because it ships an i18n runtime. Ours cannot, and an unnamed icon-only trigger is announced as just "button".

---

children

children: ReactNode

Defined in: composites/ContextualHelp/ContextualHelp.tsx:61

The explanatory content. Free-form on purpose: a heading plus a short paragraph is the common shape (Heading + Text), but the surface does not police it.

---

defaultOpen?

optional defaultOpen?: boolean

Defined in: composites/ContextualHelp/ContextualHelp.tsx:77

Whether the popover is open by default (uncontrolled).

---

evaluation?

optional evaluation?: "primary" | "secondary" | "accent" | "muted" | "negative"

Defined in: composites/ContextualHelp/ContextualHelp.tsx:71

Semantic emphasis of the trigger. muted is the default — a help glyph beside a label is ambient by definition and should materialise on hover. Read F-024's caveat first: the quiet rung's resting fill is the page surface (the owner-ruled "always paint" posture), so on a raised dark surface it shows as a patch until the stratum-aware value lands.

Default

'muted'

---

isDisabled?

optional isDisabled?: boolean

Defined in: composites/ContextualHelp/ContextualHelp.tsx:73

Whether the trigger is disabled.

---

isOpen?

optional isOpen?: boolean

Defined in: composites/ContextualHelp/ContextualHelp.tsx:75

Whether the popover is open (controlled).

---

onOpenChange?

optional onOpenChange?: (isOpen) => void

Defined in: composites/ContextualHelp/ContextualHelp.tsx:79

Handler called when the popover's open state changes.

Parameters

Parameter	Type
isOpen	boolean

Returns

void

---

placement?

optional placement?: Placement

Defined in: composites/ContextualHelp/ContextualHelp.tsx:84

Where the popover anchors relative to the trigger.

Default

'bottom start'