Schema

UI Library Schema

framework: object , x ∈ { tailwind , bootstrap , bulma }

The name of the framework.

bodyClasses: string[]
string
tailwindPlugins: string[]

Additional (allowed) Tailwind plugins list for Tailwind config.

string , x ∈ { flowbite/plugin , flowbite-typography , @tailwindcss/typography , @tailwindcss/forms , @tailwindcss/aspect-ratio , @tailwindcss/container-queries }
tailwindConfigFile: string

The filename (path to) the Tailwind CSS configuration file.

tailwindConfig: object [object Object]

The Tailwind CSS configuration object.

sassVariablesFile: string

The filename (path to) the SASS variables file.

sassVariables: string

The SASS variables string.

name: string (up to 50 chars)

The name of the UI library.

description: string (up to 100 chars)

A brief description of the UI library.

icon: string

The filename (path to) of the icon for the UI library.

iconDarkMode: string

The filename (path to) of the dark mode icon for the UI library.

categories: []

A list of categories in the UI library. Each category can have subcategories or components, but not both.

id: string

The unique identifier for the category.

name: string (up to 50 chars)

The name of the category.

subcategories: object[]

A list of subcategories in the category. Subcategories can also have their own subcategories or components, but not both.

category
components: object[]

A list of components in the category. Components can only be defined at the leaf level where there are no further subcategories.

component
assetsConfiguration: object

The configuration for the assets of the UI library.

css: object

The configuration for the CSS assets of the UI library.

files: string[]

A list of CSS files in the UI library.

string

Path to the CSS file.

cdn: string[]

A list of CDN URLs for the CSS assets of the UI library.

string

The URL to css file.

js: object

The configuration for the JavaScript assets of the UI library.

files: string[]

A list of JavaScript files in the UI library.

string

Path to the JavaScript file.

cdn: string[]

A list of CDN URLs for the JavaScript assets of the UI library.

string

The URL to js file.

assetsPath: string

The path to the assets of the UI library.

Definitions

category:

id: string

The unique identifier for the subcategory.

name: string (up to 50 chars)

The name of the subcategory.

subcategories: object[]

A list of sub-subcategories in the subcategory. Sub-subcategories can also have their own subcategories or components, but not both.

category
components: object[]

A list of components in the sub-subcategory. Components can only be defined at the leaf level where there are no further subcategories.

component

component:

id: string

The unique identifier for the component.

name: string

The name of the component.

html: string

The HTML content of the component.

html_file: string

The filename of the HTML content of the component.

Shuffle Editor

An online editor for busy developers.

Shuffle Editor on Facebook Shuffle Editor on Twitter Shuffle Editor on Dribbble

Products

UI Components

Support

Company

© 2024 Shuffle. All rights reserved.