Some checks failed
armco-org/shared-components/pipeline/head There was a failure building this commit
@armco/shared-components
Reusable React components and styles used across Armco apps.
Global stylesheet
The library ships a canonical global stylesheet (variables, mixins, animations, resets, utility classes).
Default behavior:
- Importing anything from
@armco/shared-componentsnow automatically includes the global CSS (side‑effect import insrc/index.ts). No extra step needed for host apps.
Optional explicit usage patterns:
- Explicit import (for clarity or code‑splitting boundaries):
import "@armco/shared-components/global" - Obtain URL to inject manually (e.g. server‑side rendering or HTML preload):
import cssUrl from "@armco/shared-components/global?url"then:<link rel="stylesheet" href={cssUrl} />
Why both?
- Automatic inclusion removes friction for most consumers.
- Explicit entry allows advanced setups (manual ordering, conditional loading, asset preloading).
Notes:
- Avoid importing both the base package and
./globalseparately just to prevent duplicate inclusion; one is enough. - Component-level scoped styles are still included where needed via the build pipeline.
- If you need to opt OUT of global styles, create a deep import path that bypasses
index.ts(e.g. import specific components directly) and do not import./global; this is an advanced scenario.
Components
Import the components you need:
import { Button, Modal } from "@armco/shared-components"
Peer deps: react >= 16.8
Description
Languages
TypeScript
84.1%
SCSS
13.6%
Shell
0.9%
JavaScript
0.8%
Handlebars
0.4%
Other
0.2%