@regardio/brand 0.7.7 → 0.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -6
- package/dist/components/button.d.mts +21 -0
- package/dist/components/button.mjs +13 -0
- package/dist/components/button.stories.d.mts +13750 -0
- package/dist/components/button.stories.mjs +81 -0
- package/dist/generated/icons/regardio-compass-icon.mjs +3 -5
- package/dist/generated/icons/regardio-ensemble-icon-color-full.mjs +118 -132
- package/dist/generated/icons/regardio-ensemble-icon-color.mjs +119 -133
- package/dist/generated/icons/regardio-ensemble-icon-mono.mjs +59 -30
- package/dist/generated/icons/regardio-icon-color-full.mjs +1 -3
- package/dist/generated/icons/regardio-icon-color.mjs +1 -3
- package/dist/generated/icons/regardio-icon-mono.mjs +4 -6
- package/dist/generated/icons/regardio-logo-color-light.mjs +1 -3
- package/dist/generated/icons/regardio-logo-color.mjs +3 -5
- package/dist/generated/icons/regardio-logo-mono-light.mjs +1 -3
- package/dist/generated/icons/regardio-logo-mono.mjs +2 -4
- package/dist/generated/icons/regardio-system-bridge-icon.mjs +2 -4
- package/dist/generated/icons/regardio-system-circle-icon.mjs +3 -5
- package/dist/generated/icons/regardio-system-facet-icon.mjs +3 -5
- package/dist/generated/icons/regardio-system-icon.mjs +1 -3
- package/dist/generated/icons/regardio-system-plan-icon.mjs +2 -4
- package/dist/generated/icons/regardio-system-pursuit-icon.mjs +3 -5
- package/dist/generated/icons/regardio-system-spark-icon.mjs +1 -3
- package/dist/generated/icons/regardio-system-zest-icon.d.mts +14 -0
- package/dist/generated/icons/regardio-system-zest-icon.mjs +19 -0
- package/dist/generated/sprites/compass-sprite-provider.mjs +190 -215
- package/dist/generated/sprites/compass-sprite.d.mts +1 -1
- package/dist/generated/sprites/compass-sprite.mjs +1 -3
- package/dist/styles/base.css +76 -0
- package/dist/styles/colors.css +178 -0
- package/dist/styles/grid.css +60 -0
- package/dist/styles/index.css +27 -0
- package/dist/styles/storybook.css +2 -0
- package/dist/styles/tokens.css +134 -0
- package/dist/styles/typography.css +140 -0
- package/package.json +44 -30
- package/src/components/button.stories.tsx +83 -0
- package/src/components/button.tsx +38 -0
- package/src/styles/base.css +76 -0
- package/src/styles/grid.css +60 -0
- package/src/styles/index.css +27 -0
- package/src/styles/storybook.css +2 -0
- package/src/styles/tokens.css +134 -0
- package/src/styles/typography.css +140 -0
package/README.md
CHANGED
|
@@ -2,9 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
> **Design system and branding for the Regardio ecosystem**
|
|
4
4
|
|
|
5
|
-
Regardio Brand provides the visual identity, design tokens,
|
|
6
|
-
for all Regardio applications. The package includes
|
|
7
|
-
|
|
5
|
+
Regardio Brand provides the visual identity, design tokens, brand guidelines,
|
|
6
|
+
and branded components for all Regardio applications. The package includes:
|
|
7
|
+
|
|
8
|
+
- **Design system** - Colors, typography, tokens, grid layout system
|
|
9
|
+
- **Branded components** - Button and other UI components with Regardio visual identity
|
|
10
|
+
- **Brand assets** - SVG files and React components for logos, icons, sprites
|
|
8
11
|
|
|
9
12
|
## Installation
|
|
10
13
|
|
|
@@ -12,6 +15,16 @@ ready-to-use React components.
|
|
|
12
15
|
pnpm add @regardio/brand
|
|
13
16
|
```
|
|
14
17
|
|
|
18
|
+
## Branded Components
|
|
19
|
+
|
|
20
|
+
Regardio branded components represent the Regardio visual identity (flat blue, no border, ample padding, Georama bold font). Use these consistently across all Regardio applications.
|
|
21
|
+
|
|
22
|
+
```tsx
|
|
23
|
+
import { Button } from '@regardio/brand/button';
|
|
24
|
+
|
|
25
|
+
<Button variant="primary">Click me</Button>
|
|
26
|
+
```
|
|
27
|
+
|
|
15
28
|
## Asset Catalog
|
|
16
29
|
|
|
17
30
|
Run Storybook to browse the complete asset catalog:
|
|
@@ -102,8 +115,8 @@ import { CompassSprite } from "@regardio/brand/sprites/compass-sprite";
|
|
|
102
115
|
|
|
103
116
|
Import `colors.css` to use the Regardio color palette with Tailwind CSS v4:
|
|
104
117
|
|
|
105
|
-
```
|
|
106
|
-
import "@regardio/brand/colors.css";
|
|
118
|
+
```css
|
|
119
|
+
@import "@regardio/brand/styles/colors.css";
|
|
107
120
|
```
|
|
108
121
|
|
|
109
122
|
This provides CSS custom properties using the `@theme` directive, making colors
|
|
@@ -124,6 +137,39 @@ Each color has shades from `50` (lightest) to `950` (darkest):
|
|
|
124
137
|
The compass sprites use these colors via Tailwind classes (e.g., `fill-green-300`),
|
|
125
138
|
so the color scheme must be loaded for sprites to render correctly.
|
|
126
139
|
|
|
140
|
+
### Design System Styles
|
|
141
|
+
|
|
142
|
+
Import the complete design system (colors, tokens, typography, base styles, grid):
|
|
143
|
+
|
|
144
|
+
```css
|
|
145
|
+
@import "@regardio/brand/styles/index.css";
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Or import individual style modules:
|
|
149
|
+
|
|
150
|
+
```css
|
|
151
|
+
@import "@regardio/brand/styles/colors.css";
|
|
152
|
+
@import "@regardio/brand/styles/tokens.css";
|
|
153
|
+
@import "@regardio/brand/styles/typography.css";
|
|
154
|
+
@import "@regardio/brand/styles/base.css";
|
|
155
|
+
@import "@regardio/brand/styles/grid.css";
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Grid System
|
|
159
|
+
|
|
160
|
+
Regardio's standard container and grid layout utilities:
|
|
161
|
+
|
|
162
|
+
```html
|
|
163
|
+
<div class="u-container">
|
|
164
|
+
<div class="u-grid">
|
|
165
|
+
<div class="u-grid-half">Column 1</div>
|
|
166
|
+
<div class="u-grid-half">Column 2</div>
|
|
167
|
+
</div>
|
|
168
|
+
</div>
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
See [Grid System documentation](./docs/grid-system.md) for complete usage guide.
|
|
172
|
+
|
|
127
173
|
## Scripts
|
|
128
174
|
|
|
129
175
|
| Script | Description |
|
|
@@ -141,7 +187,8 @@ so the color scheme must be loaded for sprites to render correctly.
|
|
|
141
187
|
|
|
142
188
|
| Export | Description |
|
|
143
189
|
|--------|-------------|
|
|
144
|
-
| `@regardio/brand/
|
|
190
|
+
| `@regardio/brand/button` | Branded button component |
|
|
191
|
+
| `@regardio/brand/styles/*` | Design system CSS modules (index, colors, tokens, typography, base, grid) |
|
|
145
192
|
| `@regardio/brand/icons/*` | Icon and logo React components |
|
|
146
193
|
| `@regardio/brand/sprites/*` | Compass sprite components |
|
|
147
194
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { Button as Button$1, ButtonVariant } from "@regardio/react/button";
|
|
2
|
+
import { ComponentProps } from "react";
|
|
3
|
+
|
|
4
|
+
//#region src/components/button.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* Regardio branded button component
|
|
7
|
+
*
|
|
8
|
+
* Design: Flat blue, no border, ample padding, Georama bold font
|
|
9
|
+
* This represents the Regardio visual identity and should be used
|
|
10
|
+
* consistently across all Regardio applications.
|
|
11
|
+
*/
|
|
12
|
+
interface ButtonProps extends ComponentProps<typeof Button$1> {
|
|
13
|
+
className?: string;
|
|
14
|
+
}
|
|
15
|
+
declare const Button: ({
|
|
16
|
+
children,
|
|
17
|
+
className,
|
|
18
|
+
...props
|
|
19
|
+
}: ButtonProps) => React.JSX.Element;
|
|
20
|
+
//#endregion
|
|
21
|
+
export { Button, ButtonProps, type ButtonVariant };
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Button as Button$1 } from "@regardio/react/button";
|
|
2
|
+
import { cn } from "@regardio/tailwind/utils";
|
|
3
|
+
import { jsx } from "react/jsx-runtime";
|
|
4
|
+
//#region src/components/button.tsx
|
|
5
|
+
const Button = ({ children, className, ...props }) => {
|
|
6
|
+
return /* @__PURE__ */ jsx(Button$1, {
|
|
7
|
+
className: cn("px-6", "py-3", "text-base", "font-bold", "rounded-lg", "focus-visible:ring-2", "focus-visible:ring-ring", "focus-visible:ring-offset-2", className),
|
|
8
|
+
...props,
|
|
9
|
+
children
|
|
10
|
+
});
|
|
11
|
+
};
|
|
12
|
+
//#endregion
|
|
13
|
+
export { Button };
|