You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
details: 'Theme Designer is the ultimate tool to customize and design your own themes featuring a visual editor, figma to theme code, cloud storage, and migration assistant.',
114
+
details: 'Theme Designer is the ultimate tool to customize and design your own themes featuring a visual editor, Figma to theme code, cloud storage, and migration assistant.',
>Theme Designer is the ultimate tool to customize and design your own themes featuring a visual editor, figma to theme code, cloud storage, and migration assistant. <a routerLink="/designer" class="doc-link">Discover</a> more about
25
+
>Theme Designer is the ultimate tool to customize and design your own themes featuring a visual editor, Figma to theme code, cloud storage, and migration assistant. <a routerLink="/designer" class="doc-link">Discover</a> more about
26
26
the Theme Designer by visiting the detailed <a routerLink="/designer/guide" class="doc-link">documentation</a>.</span
Token Studio in Figma is the starting point of a continuous integration pipeline. You can connect a remote repository to sync your tokens data so that changes are saved remotely instead of locally. Token Studio offers various remote
12
+
Tokens Studio in Figma is the starting point of a continuous integration pipeline. You can connect a remote repository to sync your tokens data so that changes are saved remotely instead of locally. Tokens Studio offers various remote
13
13
storage options such as <a href="https://docs.tokens.studio/token-storage/remote/sync-git-github" target="_blank" rel="noopener noreferrer">GitHub</a>,
14
14
<a href="https://docs.tokens.studio/token-storage/remote/sync-git-gitlab" target="_blank" rel="noopener noreferrer">GitLab</a> and
15
15
<a href="https://docs.tokens.studio/token-storage/remote/sync-git-bitbucket" target="_blank" rel="noopener noreferrer">Bitbucket</a>. Refer to these documentations based on your environment before proceeding to the integrations in the
Copy file name to clipboardExpand all lines: apps/showcase/doc/designer/ci/integration/bitbucket-doc.ts
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -29,9 +29,9 @@ import { AppCode } from '@/components/doc/app.code';
29
29
30
30
<h4>3. Test Integration</h4>
31
31
<p>
32
-
Edit a token in Token Studio in Figma and click <b>Push to BitBucket</b> button to update the tokens file in your Git repository, triggering the configured BitBucket Pipe. The pipe then sends the updated file content to the Theme Designer
33
-
API, receives the generated theme code, and commits the resulting changes back to your repository. An <a href="https://bitbucket.org/cagataycivici/theme-designer-ci-test" target="_blank" rel="noopener noreferrer">example repository</a> is
34
-
available at BitBucket that you may use as a starter.
32
+
Edit a token in Tokens Studio in Figma and click <b>Push to BitBucket</b> button to update the tokens file in your Git repository, triggering the configured BitBucket Pipe. The pipe then sends the updated file content to the Theme
33
+
Designer API, receives the generated theme code, and commits the resulting changes back to your repository. An
34
+
<a href="https://bitbucket.org/cagataycivici/theme-designer-ci-test" target="_blank" rel="noopener noreferrer">example repository</a> is available at BitBucket that you may use as a starter.
Copy file name to clipboardExpand all lines: apps/showcase/doc/designer/ci/integration/github-doc.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ import { RouterModule } from '@angular/router';
29
29
30
30
<h4>3. Test Integration</h4>
31
31
<p>
32
-
Edit a token in Token Studio in Figma and click <b>Push to GitHub</b> button to update the tokens file in your Git repository, triggering the configured GitHub Action. The GitHub Action then sends the updated file content to the Theme
32
+
Edit a token in Tokens Studio in Figma and click <b>Push to GitHub</b> button to update the tokens file in your Git repository, triggering the configured GitHub Action. The GitHub Action then sends the updated file content to the Theme
33
33
Designer API, receives the generated theme code, and commits the resulting changes back to your repository. An
34
34
<a href="https://github.com/primefaces/theme-designer-ci-test" target="_blank" rel="noopener noreferrer">example repository</a> is available at GitHub that you may use as a starter.
Copy file name to clipboardExpand all lines: apps/showcase/doc/designer/ci/integration/gitlab-doc.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ import { RouterModule } from '@angular/router';
32
32
33
33
<h4>4. Test Integration</h4>
34
34
<p>
35
-
Edit a token in Token Studio in Figma and click <b>Push to GitLab</b> button to update the tokens file in your Git repository, triggering the configured GitLab Action. The GitLab Action then sends the updated file content to the Theme
35
+
Edit a token in Tokens Studio in Figma and click <b>Push to GitLab</b> button to update the tokens file in your Git repository, triggering the configured GitLab Action. The GitLab Action then sends the updated file content to the Theme
36
36
Designer API, receives the generated theme code, and commits the resulting changes back to your repository. An
37
37
<a href="https://gitlab.com/cagataycivici/theme-designer-ci-test" target="_blank" rel="noopener noreferrer">example repository</a> is available at GitLab that you may use as a starter.
Copy file name to clipboardExpand all lines: apps/showcase/doc/designer/ci/overview-doc.ts
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ import { RouterModule } from '@angular/router';
10
10
template: `<app-docsectiontext>
11
11
<p>
12
12
The Figma UI Kit and the theming api is fully synchorized, meaning the design tokens in Figma map to the corresponding properties in a theme preset. The Theme Designer offers a feature to create a theme by uploading a tokens.json file
13
-
that is exported from the Token Studio plugin in Figma. Once the theme is converted, it can either be edited further in the visual editor or downloaded as a zip file to access the full code. Visit the
13
+
that is exported from the Tokens Studio plugin in Figma. Once the theme is converted, it can either be edited further in the visual editor or downloaded as a zip file to access the full code. Visit the
14
14
<a routerLink="/designer/guide#figma">Figma</a>
15
15
section at the designer documentation for more information.
The <a routerLink="/uikit">Figma UI Kit</a> and the theming api is fully synchorized, meaning the design tokens in Figma map to the CSS variables in the code. The mapping is created via the
13
-
<a href="https://tokens.studio/" target="_blank" rel="noopener noreferrer">Token Studio</a> at Figma which allows exporting a single json file. The Designer is able to interpret this file and transform it to an actual theme. In case your
14
-
UI Kit version is older, the transformation process marks the missing tokens and recommends an auto migration via the migration assistant.
12
+
For teams with UI designers, we recommend using PrimeOne Figma UI Kit for the design phase and utilizing the Theme Designer service to automate code generation during handoff. This workflow eliminates manual design-to-code translation,
13
+
reducing implementation time and ensuring consistency between design and production.
15
14
</p>
15
+
<h4>UI Kit v4</h4>
16
+
<b class="mb-4 block">Automated Flow</b>
16
17
<p>
17
-
This is an automated workflow and eliminates the manual design to code during the handoff process. If you have UI designers in your team, the recommended approach is using Figma for the actual design process and utilizing the designer for
18
-
transformation, preview and download purposes.
19
-
</p>
20
-
<b class="mb-4 block">CI Pipeline</b>
21
-
<p>
22
-
Recommended approach is setting up the CI Pipeline flow as manually exporting the tokens file from Figma and uploading it to the online designer tool may quickly become tedious in active development cycles. As a solution, theme designer
23
-
provides a remote API that can be integrated into your flow. Visit the <a routerLink="/designer/ci">CI Pipeline</a> documentation for comprehensive information and examples for GitHub, GitLab and BitBucket.
18
+
Recommended approach is using the PrimeUI Theme Generator Figma plugin which provides built-in synchronization capabilities that automate the theme generation process. Visit
19
+
<a href="https://www.figma.com/community/plugin/1592914021886732603" target="_blank" rel="noopener noreferrer">the plugin website</a> to learn more about this workflow.
24
20
</p>
25
21
<b class="mb-4 block">Manual Flow</b>
26
22
<p>
27
-
Instead of setting a CI pipeline, for quick prototyping purposes, you may also choose to use to manually export a tokens json file and then upload it to the designer. Note that, this flow would get tedious and repetitive in active
28
-
development cycles when compared to an automated CI pipeline.
23
+
Instead of generating themes directly from Figma using the plugin, for quick prototyping purposes, you may also choose to use to manually export a tokens json file and then upload it to the Theme Designer. Note that, this flow would get
24
+
tedious and repetitive in active development cycles when compared to an automated flow.
29
25
</p>
30
26
<p>
31
27
Open the <a routerLink="/uikit">PrimeOne UI Kit</a> in which you've modified tokens. In the Tokens Studio plugin, navigate to the <i>Tools</i> menu and select <i>Export to file/folder.</i> When the Export tokens modal appears, make sure
32
28
the <i>Single file</i> tab is selected. Check the <i>All tokens sets</i> option, then click <i>Export</i>.
33
29
</p>
34
30
<p>In case you utilize custom tokens, create a new token set named <i>custom</i> and define your tokens under this set to make sure they are also exported to the theme code.</p>
A tutorial is available demonstrating how the handoff process can be automated between the design team and the development team. The video demonstrates the feature from the PrimeVue version, which is exactly same as the PrimeNG
45
-
implementation.
41
+
Recommended approach is setting up the CI Pipeline flow as manually exporting the tokens file from Figma and uploading it to the online designer tool may quickly become tedious in active development cycles. As a solution, theme designer
42
+
provides a remote API that can be integrated into your flow. Visit the CI Pipeline documentation for comprehensive information and examples for GitHub, GitLab and BitBucket.
Instead of setting a CI pipeline, for quick prototyping purposes, you may also choose to use to manually export a tokens json file and then upload it to the designer. Note that, this flow would get tedious and repetitive in active
48
+
development cycles when compared to an automated CI pipeline.
49
+
</p>
50
+
<p>
51
+
Open the PrimeOne UI Kit in which you've modified tokens. In the Tokens Studio plugin, navigate to the <i>Tools</i> menu and select <i>Export to file/folder.</i> When the Export tokens modal appears, make sure the <i>Single file</i> tab
52
+
is selected. Check the <i>All tokens sets</i> option, then click <i>Export</i>.
53
+
</p>
54
+
<p>In case you utilize custom tokens, create a new token set named <i>custom</i> and define your tokens under this set to make sure they are also exported to the theme code.</p>
55
+
<img alt="Tokens Studio export" src="https://primefaces.org/cdn/designer/tokens-studio.png" class="mb-4" />
56
+
<p>When creating a new theme at Theme Designer, choose the <i>Import Figma Variables</i> option and import the json file.</p>
Copy file name to clipboardExpand all lines: apps/showcase/doc/designer/editor/intelligentcompletion-doc.ts
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,9 @@ import { AppDocSectionText } from '@/components/doc/app.docsectiontext';
12
12
feature to list the available tokens to choose from. The <i>pi-sort-alt</i> symbol over the input, transfers the token between the common tokens and color scheme specific tokens so that you are able to define tokens based on light and
0 commit comments