Style

A style guide or design system defining the visual language, design patterns, components, and standards for consistent design and development across products and platforms.

Properties

• id (string): Unique identifier for the style guide.
• name (string): The name of this style guide or design system.
• brand ([[Brand]]): The brand this style guide represents.
• business ([[Business]]): The business that owns this style guide.
• description (string): A comprehensive overview of the style guide's purpose and scope.
• version (string): Current version of the style guide.
• url ([[URL]]): URL to the published style guide documentation.
• sourceUrl ([[URL]]): URL to the source files (Figma library, Sketch symbols, etc.).
• status (string): Current status (draft, published, deprecated, archived).
• type (string): Type of style guide (brand_guidelines, design_system, ui_kit, pattern_library, component_library).
• colors (object[]): Color palette with names, values, and usage guidelines.
• typography (object[]): Typography system with fonts, sizes, weights, and hierarchy.
• spacing (object): Spacing scale and grid system specifications.
• components (object[]): Reusable UI components with specifications and code.
• patterns (object[]): Design patterns and best practices.
• icons ([[URL]][]): Icon library with usage guidelines.
• logos (object[]): Logo variations and usage rules.
• imagery (object): Guidelines for photography, illustrations, and graphics.
• voice (object): Brand voice and tone guidelines.
• accessibility (object): Accessibility standards and requirements (WCAG compliance, etc.).
• platforms (string[]): Platforms this style applies to (web, ios, android, desktop, print, etc.).
• maintainers ([[User]][]): People responsible for maintaining the style guide.
• created (number): Timestamp when the style guide was created (Unix timestamp).
• updated (number): Timestamp when the style guide was last updated (Unix timestamp).
• publishedAt (number): Timestamp when the style guide was published (Unix timestamp).
• metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Create a new style guide or design system.

Input: [[Style]]
Output: [[Style]]

update

Modify style guide content, components, or guidelines.

Input: [[Style]]
Output: [[Style]]

delete

Remove the style guide permanently.

Input: [[Style]]
Output: [[Style]]

publish

Publish the style guide for team-wide adoption.

Input: [[Style]]
Output: [[Style]]

version

Create a new version with updates and changes.

Input: [[StyleVersion]]
Output: [[Version]]

addComponent

Add a new component to the design system.

Input: [[StyleComponent]]
Output: [[Style]]

updateComponent

Modify an existing component's specifications.

Input: [[StyleComponent]]
Output: [[Style]]

removeComponent

Remove a component from the design system.

Input: [[StyleComponent]]
Output: [[Style]]

addPattern

Add a new design pattern or guideline.

Input: [[StylePattern]]
Output: [[Style]]

export

Export style guide as code, tokens, or documentation.

Input: [[StyleExport]]
Output: [[File]]

validate

Check designs for compliance with style guide.

Input: [[StyleValidation]]
Output: [[ValidationReport]]

deprecate

Mark style guide as deprecated.

Input: [[Style]]
Output: [[Style]]

archive

Move style guide to archived status.

Input: [[Style]]
Output: [[Style]]

Events

• created: Triggered when a new style guide is created.
• updated: Triggered when style guide content is modified.
• deleted: Triggered when a style guide is removed.
• published: Triggered when the style guide is published.
• deprecated: Triggered when the style guide is marked as deprecated.
• archived: Triggered when the style guide is archived.
• exported: Triggered when style guide is exported.
• Component.added: Triggered when a component is added to the system.
• Component.updated: Triggered when a component is modified.
• Component.removed: Triggered when a component is removed.
• Pattern.added: Triggered when a design pattern is added.
• Validation.completed: Triggered when design validation is completed.
• Version.created: Triggered when a new version of the style guide is created.