-
Notifications
You must be signed in to change notification settings - Fork 4
Overview
Aleksi Peebles edited this page Mar 16, 2022
·
3 revisions
The components in this component library are regular VuFind theme templates, Less and JavaScript files that are developed in a specific way.
- implement a single reusable UI element
- contain only UI-related code
- may only use vanilla PHP and allowed view helpers
- may be made up of other components
- will handle all HTML escaping in leaf components (components that do not render other components).
- contain Less and JavaScript code related to a single reusable UI element
- may use specific global Less and JavaScript code.
- are documented using component-specific documentation files
- may have data files used in building the component library website.
- have specified file paths and names.
Pattern Lab is used to generate a static component library website for viewing the components including their source code and documentation. The website also includes viewport resizer tools useful for ensuring that the components are fully responsive.
The package.json file contains scripts for automation of common tasks.
Although tools, technologies and methodologies such as Pattern Lab, Less, Bootstrap and Atomic Design are currently used, they are not hard dependencies and may be replaced, modified or left out.