Skip to content

Commit ad1e4f3

Browse files
authored
chore: renmae package to traefik-labs/faency
1 parent 9116beb commit ad1e4f3

File tree

4 files changed

+32
-32
lines changed

4 files changed

+32
-32
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ You can find the Storybook with an example for every component in this library [
1313
### How to use Faency
1414

1515
```sh
16-
npm install @traefiklabs/faency@next
16+
npm install @traefik-labs/faency@next
1717

1818
# or
1919

20-
yarn add @traefiklabs/faency@next
20+
yarn add @traefik-labs/faency@next
2121
```
2222

2323
#### Using Stitches Components (Current)
@@ -27,15 +27,15 @@ Wire up the FaencyProvider which will hold the context with the Theme configurat
2727
> The provider accepts one parameter besides the `children`, which is the `primaryColor`, that will be used to build the colors used on the Theme. This color can be one of the colors exported by the `Stitches` config, just by adding `$` as a prefix, or can be any string that represents a CSS color.
2828
2929
```jsx
30-
import { FaencyProvider } from '@traefiklabs/faency';
30+
import { FaencyProvider } from '@traefik-labs/faency';
3131

3232
const App = () => <FaencyProvider primaryColor="$blue8">{/* your app */}</FaencyProvider>;
3333
```
3434

3535
Then you are ready to import components and use them on your project:
3636

3737
```jsx
38-
import { Flex, styled } from '@traefiklabs/faency';
38+
import { Flex, styled } from '@traefik-labs/faency';
3939

4040
const Container = styled(Flex, {
4141
padding: '$3',
@@ -53,14 +53,14 @@ For better performance with static CSS, use the new Vanilla Extract components:
5353
1. Import the CSS file in your app's entry point:
5454

5555
```jsx
56-
import '@traefiklabs/faency/dist/style.css';
56+
import '@traefik-labs/faency/dist/style.css';
5757
```
5858

5959
2. Wrap your app with the VanillaExtractThemeProvider:
6060

6161
```jsx
62-
import { VanillaExtractThemeProvider } from '@traefiklabs/faency';
63-
import { BoxVanilla, BadgeVanilla } from '@traefiklabs/faency';
62+
import { VanillaExtractThemeProvider } from '@traefik-labs/faency';
63+
import { BoxVanilla, BadgeVanilla } from '@traefik-labs/faency';
6464

6565
const App = () => (
6666
<VanillaExtractThemeProvider defaultTheme="light" primaryColor="blue">

USER_GUIDE.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Install Faency via npm or yarn:
2020

2121
```bash
2222
# npm
23-
npm install @traefiklabs/faency
23+
npm install @traefik-labs/faency
2424

2525
# yarn
26-
yarn add @traefiklabs/faency
26+
yarn add @traefik-labs/faency
2727
```
2828

2929
### Peer Dependencies
@@ -46,8 +46,8 @@ Wrap your application with the `FaencyProvider`:
4646

4747
```tsx
4848
import React from 'react';
49-
import { FaencyProvider } from '@traefiklabs/faency';
50-
import { Button, Box, Text } from '@traefiklabs/faency';
49+
import { FaencyProvider } from '@traefik-labs/faency';
50+
import { Button, Box, Text } from '@traefik-labs/faency';
5151

5252
function App() {
5353
return (
@@ -69,9 +69,9 @@ For Vanilla Extract components, import the CSS file and use the `VanillaExtractT
6969

7070
```tsx
7171
import React from 'react';
72-
import '@traefiklabs/faency/dist/style.css'; // Required for Vanilla Extract components
73-
import { VanillaExtractThemeProvider } from '@traefiklabs/faency';
74-
import { BoxVanilla, BadgeVanilla } from '@traefiklabs/faency';
72+
import '@traefik-labs/faency/dist/style.css'; // Required for Vanilla Extract components
73+
import { VanillaExtractThemeProvider } from '@traefik-labs/faency';
74+
import { BoxVanilla, BadgeVanilla } from '@traefik-labs/faency';
7575

7676
function App() {
7777
return (
@@ -97,7 +97,7 @@ Stitches components use runtime CSS-in-JS, so no separate CSS imports are needed
9797
Vanilla Extract components require importing the static CSS file. Add this import to your application's entry point (e.g., `App.tsx` or `index.tsx`):
9898

9999
```tsx
100-
import '@traefiklabs/faency/dist/style.css';
100+
import '@traefik-labs/faency/dist/style.css';
101101
```
102102

103103
This CSS file contains all the styles for Vanilla Extract components (components with `Vanilla` suffix like `BadgeVanilla`, `BoxVanilla`, etc.). Without this import, these components will render as unstyled elements.
@@ -119,7 +119,7 @@ Faency includes a powerful theming system with support for light/dark modes and
119119
For more control over theming, use the new Vanilla Extract theme provider:
120120

121121
```tsx
122-
import { VanillaExtractThemeProvider } from '@traefiklabs/faency';
122+
import { VanillaExtractThemeProvider } from '@traefik-labs/faency';
123123

124124
function App() {
125125
return (
@@ -151,7 +151,7 @@ Faency supports 7 primary color themes:
151151
#### With Vanilla Extract Provider
152152

153153
```tsx
154-
import { VanillaExtractThemeProvider } from '@traefiklabs/faency';
154+
import { VanillaExtractThemeProvider } from '@traefik-labs/faency';
155155

156156
function App() {
157157
return (
@@ -167,7 +167,7 @@ function App() {
167167
Access and control the theme using the `useVanillaExtractTheme` hook:
168168

169169
```tsx
170-
import { useVanillaExtractTheme } from '@traefiklabs/faency';
170+
import { useVanillaExtractTheme } from '@traefik-labs/faency';
171171

172172
function ThemeToggle() {
173173
const { mode, resolvedTheme, primaryColor, setMode, setPrimaryColor } = useVanillaExtractTheme();
@@ -220,18 +220,18 @@ function ThemeToggle() {
220220

221221
```tsx
222222
// Import individual components
223-
import { Button, Box, Text, Input, Badge } from '@traefiklabs/faency';
223+
import { Button, Box, Text, Input, Badge } from '@traefik-labs/faency';
224224

225225
// Or import everything
226-
import * as Faency from '@traefiklabs/faency';
226+
import * as Faency from '@traefik-labs/faency';
227227
```
228228

229229
### Basic Component Usage
230230

231231
#### Button
232232

233233
```tsx
234-
import { Button } from '@traefiklabs/faency';
234+
import { Button } from '@traefik-labs/faency';
235235

236236
<Button variant="primary" size="medium">
237237
Click Me
@@ -247,7 +247,7 @@ import { Button } from '@traefiklabs/faency';
247247
#### Box (Layout Container)
248248

249249
```tsx
250-
import { Box } from '@traefiklabs/faency';
250+
import { Box } from '@traefik-labs/faency';
251251

252252
<Box css={{ p: '$4', bc: '$blue4', br: '$2' }}>Content goes here</Box>;
253253
```
@@ -257,7 +257,7 @@ The Box component is a flexible container for layouts. Use it with the `css` pro
257257
#### Text
258258

259259
```tsx
260-
import { Text } from '@traefiklabs/faency';
260+
import { Text } from '@traefik-labs/faency';
261261

262262
<Text size="4" css={{ c: '$blue11' }}>
263263
Styled text content
@@ -441,7 +441,7 @@ Faency is built with TypeScript and provides full type definitions.
441441
All component props are fully typed:
442442

443443
```tsx
444-
import { Button } from '@traefiklabs/faency';
444+
import { Button } from '@traefik-labs/faency';
445445
import type { ComponentProps } from 'react';
446446

447447
// Get the prop types
@@ -455,7 +455,7 @@ function MyButton(props: ButtonProps) {
455455
### CSS Prop Types
456456

457457
```tsx
458-
import type { CSSProps } from '@traefiklabs/faency';
458+
import type { CSSProps } from '@traefik-labs/faency';
459459

460460
interface MyComponentProps extends CSSProps {
461461
label: string;
@@ -469,7 +469,7 @@ function MyComponent({ label, css }: MyComponentProps) {
469469
### Theme Types
470470

471471
```tsx
472-
import type { PrimaryColor, ThemeMode } from '@traefiklabs/faency';
472+
import type { PrimaryColor, ThemeMode } from '@traefik-labs/faency';
473473

474474
const primaryColor: PrimaryColor = 'blue';
475475
const themeMode: ThemeMode = 'light';
@@ -552,7 +552,7 @@ Use Box for layout composition:
552552
For new projects, use the Vanilla Extract components (when available) for better performance:
553553

554554
```tsx
555-
import { BoxVanilla } from '@traefiklabs/faency';
555+
import { BoxVanilla } from '@traefik-labs/faency';
556556

557557
// Better performance with static CSS
558558
<BoxVanilla css={{ p: '$4' }}>Content</BoxVanilla>;
@@ -573,7 +573,7 @@ import {
573573
Button,
574574
Text,
575575
Badge,
576-
} from '@traefiklabs/faency';
576+
} from '@traefik-labs/faency';
577577

578578
function ThemeControls() {
579579
const { resolvedTheme, setMode, primaryColor, setPrimaryColor } = useVanillaExtractTheme();
@@ -642,6 +642,6 @@ export default App;
642642
## Additional Resources
643643

644644
- [Component Documentation](https://storybook.traefik.io/faency) - Interactive component examples
645-
- [GitHub Repository](https://github.com/traefiklabs/faency) - Source code and issues
645+
- [GitHub Repository](https://github.com/traefik/faency) - Source code and issues
646646
- [Vanilla Extract Migration Guide](./VANILLA_EXTRACT_DEVELOPER_GUIDE.md) - For contributors
647647
- [Project Guidelines](./CLAUDE.md) - Development guidelines

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@traefiklabs/faency",
2+
"name": "@traefik-labs/faency",
33
"description": "Traefik Labs design system",
44
"version": "1.0.0-semantic-release",
55
"license": "Apache-2.0",

yarn.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5743,9 +5743,9 @@ __metadata:
57435743
languageName: node
57445744
linkType: hard
57455745

5746-
"@traefiklabs/faency@workspace:.":
5746+
"@traefik-labs/faency@workspace:.":
57475747
version: 0.0.0-use.local
5748-
resolution: "@traefiklabs/faency@workspace:."
5748+
resolution: "@traefik-labs/faency@workspace:."
57495749
dependencies:
57505750
"@babel/core": "npm:^7.15.4"
57515751
"@babel/plugin-transform-react-pure-annotations": "npm:^7.16.7"

0 commit comments

Comments
 (0)