codebase-overview.md

Codebase Overview

This section will give you an overview of the Elements codebase organization, its conventions, and the implementation.

Top-Level

• .build - custom TypeScript compiler and bundler plugins.
• .github - GitHub Workflows for PRs and releases.
• .storybook - Storybook configuration.

Source (/src)

• elements - all custom elements in the library.
  • internal - custom elements for internal use in global registry, grouped by class name.
  • private - custom elements for internal use in scoped registries, grouped by class name.
  • public - custom elements for public use, grouped by class name.
• events - common events (deprecated).
• global - JS globals (deprecated).
• mixins - various mixins for internal use.
• mocks - hAPI and i18next data for testing (deprecated).
• server - mock server for demo and test purposes.
• static - static files like images and translations.
• storygen - story generation utilities for Storybook.
• testgen - various test helpers.
• types - common type definitions and augmentations for packages without type info.
• utils - shared utilities.
• env.ts - process.env config (deprecated).
• index.defined.ts - library export that defines custom elements on import.
• index.ts - main library export (bare element classes).

Translations (/src/static/translations)

• admin - i18n files for the Foxy Admin (deprecated).
• country - localized country names (deprecated).
• customer-portal - translations specific to the Customer Portal.
• customer-portal-settings - translations specific to the Customer Portal Settings.
• donation - translations specific to the Donation Form.
• global - common translations for pre-Nucleon elements (deprecated).
• items-form - translations specific to the Items Form.
• region - localized region names (deprecated).
• shared - common translations, fallbacks.