Skip to content

Commit f9252c4

Browse files
committed
feat: release 7
1 parent 18fef01 commit f9252c4

File tree

238 files changed

+9077
-3839
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

238 files changed

+9077
-3839
lines changed

.env.example

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,7 @@ UNIFORM_PREVIEW_SECRET=hello-world
99
# defaults to localhost:3000 if not set.
1010
#When set, should resolve to the base url of the app.
1111
# This is used to generate the sitemap and robots.txt
12-
BASE_URL=
12+
BASE_URL=
13+
14+
# Temporarily, you need to provide an NPM token to download the new SDK alpha packages.
15+
NPM_TOKEN=

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
2+
node-linker=hoisted

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Run `npx @uniformdev/cli new` and pick `Next.js` -> `Component Starter Kit` from
4747
> Make sure your API key has "Developer" role to be able to push content.
4848
1. `npm install` to install dependencies
4949
1. Run `npm run init` to initialize your project.
50-
> This will push all content from disk (`.\content` folder) and your design settings (colors, fonts, borders, etc. for this default theme).
50+
> This command uses `@uniformdev/csk-cli` to push all content from disk (`./content` folder), design settings (colors, fonts, borders, etc.), and publish the context manifest. If CSK variants are available, you'll be prompted to select which one to initialize.
5151
5252
### Step 2. Run locally in dev mode
5353

@@ -66,7 +66,16 @@ This integration brings new parameter types for design and layout control via Un
6666

6767
The following scripts are created to facilitate sync of content between the `./content` folder and your project.
6868

69-
1. Run `npm run push:content` to push data from disk (see `./content`) to your Uniformproject.
69+
### Complete Project Sync
70+
71+
1. Run `npm run init` to initialize/push everything (content, design extensions, and context manifest) to your Uniform project.
72+
2. Run `npm run uniform:pull` to pull everything (content and design extensions) from your Uniform project to disk.
73+
74+
These commands use `@uniformdev/csk-cli` and handle the complete synchronization workflow. If CSK variants are available, you'll be prompted to select which one to sync.
75+
76+
### Granular Content Sync
77+
78+
1. Run `npm run push:content` to push data from disk (see `./content`) to your Uniform project.
7079
1. Run `npm run pull:content` to pull data from your Uniform project to `./content` folder.
7180

7281
Alternatively you can use `npm run pull:content:dev` and `npm run push:content:dev` to pull and push developer-owned content to your local project. The scope of the developer-owned content is defined in the `uniform.config.dev.ts` file.
@@ -83,6 +92,7 @@ Whenever you add new **colors, dimensions, fonts, or borders**, your application
8392

8493
```sh
8594
npm run pull:dex
95+
npm run apply:dex
8696
```
8797

8898
This command is automatically executed when running:
@@ -105,16 +115,10 @@ When modifying an **existing value**, your app will automatically fetch the upda
105115

106116
## 🎨 Working with Styles
107117

108-
If you prefer managing styles manually, you can modify the predefined configuration files located in the `styles/` directory:
109-
110-
- `styles/border.css`
111-
- `styles/colors.css`
112-
- `styles/dimensions.css`
113-
- `styles/fonts.css`
114-
115-
After making changes, push the updated configuration using:
118+
If you prefer managing styles manually, you can modify the predefined configuration files `dex.config.json`. After making changes, apply and push the updated configuration using:
116119

117120
```sh
121+
npm run apply:dex
118122
npm run push:dex
119123
```
120124

@@ -143,16 +147,16 @@ By default, the **Design Extension** includes two predefined groups:
143147
- `button`
144148
- `text`
145149

146-
### **Understanding `allowGroups.json`**
150+
### **Understanding `allowGroups`**
147151

148-
When your project is still using the default configuration, the `allowGroups.json` file will be **empty**. However, if you add a custom group (e.g., `page`), it will be added to this file automatically.
152+
When your project is still using the default configuration, the `allowGroups` field will be **empty**. However, if you add a custom group (e.g., `page`), it will be added to this field automatically.
149153

150154
#### **Example: Adding a Custom Group (Page)**
151155

152-
If you introduce a new group, such as `page`, the `allowGroups.json` file will be updated as follows:
156+
If you introduce a new group, such as `page`, the `dex.config.json` file will be updated as follows:
153157

154158
```json
155-
{ "color": ["button", "page", "text"] }
159+
allowedGroups: { "color": ["button", "page", "text"] }
156160
```
157161

158162
### **Creating and Pushing Custom Groups**

content/compositionPattern/f9c058ea-c40d-4435-ac5a-53423cf654dc.yaml

Lines changed: 0 additions & 116 deletions
This file was deleted.

0 commit comments

Comments
 (0)