@financial-times/ft-concept-button
Version:
ft concept button (includes the ft follow button)
43 lines (30 loc) • 1.28 kB
Markdown
## Members
<dl>
<dt><a href="#isPressed">isPressed</a></dt>
<dd><p>Set the followed state
Updates the UI and adds text to the a11y box.</p>
</dd>
</dl>
## Functions
<dl>
<dt><a href="#init">init(rootEl, [options])</a> ⇒ <code>FtConceptButton</code> | <code>Array.<FtConceptButton></code></dt>
<dd><p>Initialize components on the page</p>
</dd>
</dl>
<a name="isPressed"></a>
## isPressed
Set the followed state
Updates the UI and adds text to the a11y box.
**Kind**: global variable
| Param | Type | Description |
| --- | --- | --- |
| [state] | <code>boolean</code> | the state to set |
<a name="init"></a>
## init(rootEl, [options]) ⇒ <code>FtConceptButton</code> \| <code>Array.<FtConceptButton></code>
Initialize components on the page
**Kind**: global function
**Returns**: <code>FtConceptButton</code> \| <code>Array.<FtConceptButton></code> - - ft-concept-button instance(s)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| rootEl | <code>Element</code> \| <code>HTMLElement</code> \| <code>string</code> | | The root element to initialize the component in, or a CSS-style selector for the root element |
| [options] | <code>object</code> | <code>{}</code> | An options object for configuring the component |