# Beacon Beacon is the design system for Employee Navigator, a benefits-administration platform. It ships two themes: `benefits` (broker/admin, the default) and `employee` (the enrollment experience). A class or component present in one theme is not necessarily present in the other — check before assuming. ## Structured data (prefer these over scraping pages) - [/api/component-meta/en-components.json](https://beacon.employeenavigator.net/api/component-meta/en-components.json): Every documented component in @front-end/en-components: props (with type, default, required, description), slots, events, and methods. - [/api/component-meta/en-forms.json](https://beacon.employeenavigator.net/api/component-meta/en-forms.json): Every documented component in @front-end/en-forms: props (with type, default, required, description), slots, events, and methods. - [/api/icons.json](https://beacon.employeenavigator.net/api/icons.json): Complete list of icon-font glyph names. Authoritative for whether a glyph exists. - [/api/css-classes.json](https://beacon.employeenavigator.net/api/css-classes.json): Compiled CSS selectors with their properties. Authoritative for whether a utility class exists. - [/api/pages.json](https://beacon.employeenavigator.net/api/pages.json): The documentation inventory: every page, its title, the component it documents, and whether it carries usage guidance. Replaces scraping the sidebar to learn what exists. - [/api/guidance.json](https://beacon.employeenavigator.net/api/guidance.json): Which page governs the usage of which component or class, via its Guidelines / Dos / Don’ts / Variants sections. Authoritative for how and when to use something, as opposed to whether it exists. - [/api/index.json](https://beacon.employeenavigator.net/api/index.json): Manifest of the above, with counts and shapes. ## Notes for tools reading the rendered site - Live component demos render inside a shadow root and are **not** in the prerendered HTML. Do not conclude something is missing because a demo's markup is absent — use the JSON above. - The icon list on /styleguide/icons/ is one such demo. `/api/icons.json` is authoritative. - Component metadata lists only the props a component **declares itself**. Wrapper components forward props they do not declare — `EnPopover` renders `EnTooltip` internally and accepts its props too. If a prop is absent, check the component it wraps before concluding it is unsupported. - A capability is often a generic mechanism rather than a prop named after the need. Column alignment, for example, is a table heading's `class` property plus a `text-right` utility — nothing is named "alignment". - **Existence and usage are different questions.** The resources above answer whether something exists. Whether it is the *right* component, or whether Beacon endorses a pattern, is answered only by a page's **Guidelines / Dos / Don'ts / Variants** sections — see `/api/guidance.json` for which page governs which component or class. The design narrative under /design/ describes what the system is trying to be; it is not authority for which control to use. Example: the palette has one brand blue, and `.btn-success` is still the documented button for Save. - **Component pages render their props tables and demos in the browser** from the metadata above. A text search of a rendered page will not find a prop that is fully documented and demonstrated, so never conclude a capability is undocumented from a search — check the metadata. ## Key pages - [Styleguide](https://beacon.employeenavigator.net/styleguide/): CSS-level patterns — typography, colors, panels, tables, utilities. - [Icons](https://beacon.employeenavigator.net/styleguide/icons/): The icon font, plus guidance on choosing a status glyph. - [en-components](https://beacon.employeenavigator.net/en-components/): Vue components — modals, tables, tooltips, toaster. - [en-forms](https://beacon.employeenavigator.net/en-forms/): Vue form inputs and validation. - [Print](https://beacon.employeenavigator.net/styleguide/utilities/general#print): What the print stylesheet does, and the boundary between a printed Beacon page and a generated PDF.