access-nyc-patterns
Version:
User Interface Patterns for Benefits Access
34 lines (21 loc) • 1.17 kB
Markdown
### Global Script
The Accordion Component requires JavaScript for functionality and screen reader accessibility. To use the Accordion in the global ACCESS NYC Patterns script use the following code:
<!-- Global Script -->
<script src="dist/scripts/access-nyc.js"></script>
<script>
var access = new AccessNyc();
access.accordion();
</script>
This function will attach the accordion toggling event to the body of the document.
### Module
The ES6, CommonJS, and IFFE modules all require importing and object instantiation in your main script:
// ES6
import Filter from 'src/components/accordion/accordion';
// CommonJS
import Filter from 'dist/components/accordion/accordion.common';
<!-- IFFE -->
<script src="dist/components/accordion/accordion.iffe.js"></script>
new Accordion();
The component requires the `data-js="accordion"` attribute and a unique ID targeting the Accordion body, on the toggling element, in order to function.
#### Polyfills
This script uses the Toggle Utility as a dependency and requres the same polyfills. See the ["Toggle Usage" section](toggle#toggle-usage) for more details.