Help Button
import "@taprootio/espalier/help/button";
<esp-help-button>
An icon-only trigger for URL-addressable help. Set help-url directly or
place the button beneath an ancestor carrying help-src; anchor selects
a stable heading id inside that document. The provider keeps the button's
pressed state synchronized while its topic is showing.
Attributes
<esp-help-button> has the following attributes:
help-url
help-url has a default value of "".
Per-trigger help document override. May include a topic fragment. When
omitted, the nearest composed-tree ancestor's help-src is used.
anchor
anchor has a default value of "".
Stable heading id inside the resolved help document.
label
label has a default value of "Help".
Accessible label for the icon-only button.
title
title has a default value of "".
Optional flyout heading. Topic/document headings are used when omitted.
active
active has a default value of false.
Whether this button's exact help topic is currently showing.
intent
intent has a default value of undefined.
The element's intent — its meaning: neutral
(no pin), or success, warning, danger, info — each pinned
to its fixed status family (blue for info), retunable per theme
via intents. On token-emitting controls a non-neutral intent pins the
filled-action pair to that family, derived over the governing
zone's theme; class-styled chrome (badges, callouts, status pills)
opts out of inline emission and renders its treatment from CSS
classes instead. An intent never repaints the surrounding zone,
which is what contexts are for. Removing the attribute restores
the element's own default intent.
context
context has a default value of undefined.
A theme-defined color zone. The selected context rebinds designer-facing roles and emits a complete, contrast-enforced semantic token table on this host for descendants to inherit.
Methods
<esp-help-button> has the following methods:
focus
Forward focus to the composed native control.
traverseToClosest
Traverse up the DOM tree to find the closest element that matches the selector. This method is aware of shadow DOM boundaries and will traverse through them to find the element.
CSS Properties
<esp-help-button> has the following CSS properties:
--esp-field-background
Background color of the shared field shell. Defaults to var(--esp-color-layer-2).
--esp-field-border-color
Border color of the shared field shell. Defaults to var(--esp-color-border).
--esp-field-border-width
Border width of the shared field shell. Defaults to 1px.
--esp-field-text-color
Text color used inside the shared field shell. Defaults to var(--esp-color-text).
--esp-field-hover-bg
Hover background color of the shared field shell. Derived from --esp-field-background.
--esp-field-focus-bg
Focus background color of the shared field shell. Derived from --esp-field-background.
--esp-field-focus-shadow
Shadow color used for shared field focus treatment. Defaults to var(--esp-color-shadow).