Enhancing Design Collaboration: The ZK Figma Kit for Seamless Web App Development"

From Documentation
m
 
(39 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Template:Smalltalk_Author
 
{{Template:Smalltalk_Author
|author=
+
|author= Jean Yen, Customer Care
|date=
+
|date= Nov. 25, 2024
|version=ZK 10.0.0}}
+
|version=1.0-Beta}}
  
 
__TOC__
 
__TOC__
  
 
= Introduction =
 
= Introduction =
In the world of web application development, collaboration between designers and developers has become more essential than ever. While developers traditionally focused on directly building UIs, today, many companies employ dedicated design teams to lay out the visual aspects of their applications.  
+
In the world of web application development, collaboration between designers and developers has become more essential than ever. While ZK developers traditionally focused on directly building UIs, today, many companies employ dedicated design teams to lay out the visual aspects of their applications.  
  
To support this, we’re excited to introduce the ZK Figma Kit—a design-ready file packed with all our UI components, making it easy for design teams to create detailed, functional layouts. With this kit, designers can craft comprehensive UI plans in Figma that developers can seamlessly bring to life, ensuring a smooth and efficient transition from design to deployment.
+
To support this, we’re excited to introduce the '''ZK Framework UI Kit''' — a design-ready Figma file packed with all our core UI components, making it easy for design teams to create detailed, functional layouts. With this kit, designers can craft comprehensive UI plans in Figma that developers can seamlessly bring to life, ensuring a smooth and efficient transition from design to deployment.
 +
 
 +
[[File:ZK-figma-overview.png||center|ZK Framework UI Kit]]
 +
 
 +
 
 +
[[File:ZK-figma-overview2.png||center|ZK Framework UI Kit]]
  
 
= Key Features =
 
= Key Features =
 
== Ready-to-Use Figma File for ZK Components ==
 
== Ready-to-Use Figma File for ZK Components ==
The ZK Figma Kit is a comprehensive, ready-to-use resource that includes all standard ZK components, giving designers everything they need to create layouts that developers can easily follow.
+
The ZK Framework UI Kit is a comprehensive, ready-to-use resource that includes all core ZK components, giving designers everything they need to create layouts that developers can easily follow.
 +
 
 
== Support for Both Standard and Compact Themes ==
 
== Support for Both Standard and Compact Themes ==
The kit comes with ZK’s two most popular themes: Iceblue (iceblue) and Iceblue Compact (iceblue_c). Designers can experiment with both the standard and compact layouts to determine the best fit for their project’s needs.
+
The kit comes with ZK’s two most popular themes: Iceblue (iceblue) and Iceblue Compact (iceblue_c). Designers can experiment with both the standard and compact components to determine the best fit for their project’s needs.
  
 
== Custom Theme ==
 
== Custom Theme ==
Colors and font sizes are grouped using Figma’s variant feature, making it easy to experiment with different colors and apply a custom theme to match corporate or project branding. These elements map directly to the CSS/LESS files used in the application, simplifying the developer’s work once the designer defines the custom colors.
+
In this kit, colors are set up as local styles, making it easy to experiment with different colors and apply a custom theme to match corporate or project branding. These styles map directly to the CSS/LESS files used in the application, simplifying the developer’s work once the designer defines the custom colors.
To apply the custom theme efficiently in your LESS files, we recommend using the [xxx plugin]. Here’s a step-by-step guide to streamline the process: [link to steps].
+
 
 +
For theme customization, ZK developers use the [https://github.com/zkoss/zkThemeTemplate/blob/master/readme.md zkThemeTemplate] tool. By overriding existing LESS variables with new styles, developers can efficiently apply the custom theme.
 +
 
 +
Once local styles are updated in the ZK Framework UI Kit, developers can extract customized styles by using plugins, for example,  [https://www.figma.com/community/plugin/742750636238601912/cssgen CSSGen]. Developers can then copy and paste these styles into zkThemeTemplate, ensuring a smooth implementation of the new theme.
 +
 
 +
[[File:CSSGen-plugin.png||center|Local styles can be extracted using plugins]]
 +
 
 +
=== Migrate from an older Theme ===
 +
If you are using an older ZK version with a deprecated theme (e.g., Breeze, Silvertail, Sapphire, or Atlantic) and wish to maintain a similar look and feel when upgrading to ZK 10, you can use the ZK UI kit to experiment with your theme's color schemes. This allows you to preview and adjust the colors. Please note that only color schemes will be applied; structural changes, such as gradients, will not be included.
  
 
== Dynamic Status Representation with Variable Controls ==
 
== Dynamic Status Representation with Variable Controls ==
The kit supports variable-controlled component states—such as hover, checked, and collapsed/expanded—allowing designers to represent different UI states accurately and flexibly.
+
The kit supports variable-controlled component states—such as hover, checked, and collapsed/expanded—allowing designers to represent different UI states accurately and flexibly. [https://youtu.be/2FU0b6pVjOI View the demo here].
  
 
== Advanced Customization Options ==
 
== Advanced Customization Options ==
For advanced customization, components can be ungrouped to make detailed modifications, ensuring designs meet specific project requirements and preferences.
+
For advanced customization, designers can detach components to make detailed modifications, ensuring designs meet specific project requirements and preferences. [https://youtu.be/8uF4J6c3ENE View the demo here].
  
 
= Typical Workflow: Designers and Developers Working Together =
 
= Typical Workflow: Designers and Developers Working Together =
# The designer creates the web app layout using the ZK Figma Kit, customizing details such as theme, spacing, margins, and layout.
+
# The designer creates the web app layout using the ZK Framework UI Kit. Start by experimenting and choosing between the Standard and the Compact Components. Once the theme is decided, use all components from the same group (do not mix Standard and Compact components).
 +
# Layout your pages. Customize details such as colors, spacing, and margins.
 
# Internal approval of the design, if required.
 
# Internal approval of the design, if required.
# The developer follows the Figma file to build the web application. Custom attributes, including colors and other styling elements, can be exported and applied to the LESS file (refer to [xxx section] above).
+
# The developer follows the Figma file to build the web application. Local styles can be exported and applied to the LESS file (refer to [[Small_Talks/2024/November/Enhancing_Design_Collaboration:_The_ZK_Figma_Kit_for_Seamless_Web_App_Development#Custom_Theme|Custom Theme]] above).
  
 
== Download ==
 
== Download ==
Download the ZK Figma Kit here: [download link].
+
Download the [https://zkoss.org/zkdownload/startEvalFileDownload?id=396847541 ZK Framework UI Kit (Figma) here >>]
  
 
= Summary =
 
= Summary =
The ZK Figma Kit is designed to simplify collaboration between designers and developers, enabling the creation of robust and visually appealing applications. We invite you to try it out and let us know how it enhances your productivity. We welcome your feedback at info@zkoss.org.
+
The ZK UI Kit is designed to simplify collaboration between designers and developers, enabling the creation of robust and visually appealing applications. This is our first version of the kit, and we’re committed to continuously improving it based on your feedback. We invite you to try it out, see how it enhances your productivity, and let us know any ideas or suggestions you may have at info@zkoss.org.
  
 
[[Category:New Features]]
 
[[Category:New Features]]

Latest revision as of 16:45, 22 November 2024

DocumentationSmall Talks2024NovemberEnhancing Design Collaboration: The ZK Figma Kit for Seamless Web App Development
Enhancing Design Collaboration: The ZK Figma Kit for Seamless Web App Development

Author
Jean Yen, Customer Care
Date
Nov. 25, 2024
Version
1.0-Beta

Introduction

In the world of web application development, collaboration between designers and developers has become more essential than ever. While ZK developers traditionally focused on directly building UIs, today, many companies employ dedicated design teams to lay out the visual aspects of their applications.

To support this, we’re excited to introduce the ZK Framework UI Kit — a design-ready Figma file packed with all our core UI components, making it easy for design teams to create detailed, functional layouts. With this kit, designers can craft comprehensive UI plans in Figma that developers can seamlessly bring to life, ensuring a smooth and efficient transition from design to deployment.

ZK Framework UI Kit


ZK Framework UI Kit

Key Features

Ready-to-Use Figma File for ZK Components

The ZK Framework UI Kit is a comprehensive, ready-to-use resource that includes all core ZK components, giving designers everything they need to create layouts that developers can easily follow.

Support for Both Standard and Compact Themes

The kit comes with ZK’s two most popular themes: Iceblue (iceblue) and Iceblue Compact (iceblue_c). Designers can experiment with both the standard and compact components to determine the best fit for their project’s needs.

Custom Theme

In this kit, colors are set up as local styles, making it easy to experiment with different colors and apply a custom theme to match corporate or project branding. These styles map directly to the CSS/LESS files used in the application, simplifying the developer’s work once the designer defines the custom colors.

For theme customization, ZK developers use the zkThemeTemplate tool. By overriding existing LESS variables with new styles, developers can efficiently apply the custom theme.

Once local styles are updated in the ZK Framework UI Kit, developers can extract customized styles by using plugins, for example, CSSGen. Developers can then copy and paste these styles into zkThemeTemplate, ensuring a smooth implementation of the new theme.

Local styles can be extracted using plugins

Migrate from an older Theme

If you are using an older ZK version with a deprecated theme (e.g., Breeze, Silvertail, Sapphire, or Atlantic) and wish to maintain a similar look and feel when upgrading to ZK 10, you can use the ZK UI kit to experiment with your theme's color schemes. This allows you to preview and adjust the colors. Please note that only color schemes will be applied; structural changes, such as gradients, will not be included.

Dynamic Status Representation with Variable Controls

The kit supports variable-controlled component states—such as hover, checked, and collapsed/expanded—allowing designers to represent different UI states accurately and flexibly. View the demo here.

Advanced Customization Options

For advanced customization, designers can detach components to make detailed modifications, ensuring designs meet specific project requirements and preferences. View the demo here.

Typical Workflow: Designers and Developers Working Together

  1. The designer creates the web app layout using the ZK Framework UI Kit. Start by experimenting and choosing between the Standard and the Compact Components. Once the theme is decided, use all components from the same group (do not mix Standard and Compact components).
  2. Layout your pages. Customize details such as colors, spacing, and margins.
  3. Internal approval of the design, if required.
  4. The developer follows the Figma file to build the web application. Local styles can be exported and applied to the LESS file (refer to Custom Theme above).

Download

Download the ZK Framework UI Kit (Figma) here >>

Summary

The ZK UI Kit is designed to simplify collaboration between designers and developers, enabling the creation of robust and visually appealing applications. This is our first version of the kit, and we’re committed to continuously improving it based on your feedback. We invite you to try it out, see how it enhances your productivity, and let us know any ideas or suggestions you may have at info@zkoss.org.

Comments



Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.