@aurodesignsystem-dev/auro-drawer
v0.0.0-pr131.16
Published
auro-drawer HTML custom element
Readme
Drawer
The <auro-drawer> element is an intrusive interactive element, not passive. The element is best used when there is a requirement the user be made aware of the content being shown, moving focus from the main content to the drawer content.
The element also supports a modal (blocking) state where the user must interact with the content of the element in order to continue. Passive dismissal of the content is not allowed. Users of this state must add a trigger for the user to move beyond this content.
Use Cases
The auro-drawer component should be used in situations where users may:
- Be prompted to take an action before doing anything else or going back
- Be prompted to view content with the option of closing it
Install
Define Dependency in Project
Defining the dependency within each project that is using the <auro-drawer> component.
Use CDN
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
Basic Example
Custom Component Registration for Version Management
There are two key parts to every Auro component: the class and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
When you install the component as described on the Install page, the class is imported automatically, and the component is registered globally for you.
However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
You can do this by importing only the component class and using the register(name) method with a unique name:
This will create a new custom element <custom-drawer> that behaves exactly like <auro-drawer>, allowing both to coexist on the same page without interfering with each other.
