Skip to content

jundaoapp/design

Repository files navigation

Jundao Design banner Jundao Design banner

Jundao Design

A simple, fast and modern SolidJS UI library.

license checks npm

Warning Jundao Design is in early stage and not ready for production.
Unstable API, see Versioning

Features

  • Fast - Built on SolidJS.
  • Type Safe - Entirely coded in Typescript.
  • Modern - Uses the latest available ES & CSS features.
  • Accessible - WAI-ARIA compliant.
  • Mobile Friendly - All components tested for desktop & touch.
  • Fun - Amazing and friendly DX.
  • Consistant - Style and behaviour tested across all modern browsers.
  • Responsive - Designed for all screen sizes.
  • Fresh UI - Light & Dark mode with professional looking design.

Usage

Install @jundao/design and peer dependency fonts:

npm install @jundao/design@alpha @fontsource-variable/inter @fontsource-variable/jetbrains-mono
# or
yarn add @jundao/design@alpha @fontsource-variable/inter @fontsource-variable/jetbrains-mono
# or
pnpm add @jundao/design@alpha @fontsource-variable/inter @fontsource-variable/jetbrains-mono

Import in entrypoint:

import "@jundao/design/index.css";

// Fonts
import "@fontsource-variable/inter";
import "@fontsource-variable/jetbrains-mono";

Import components:

import {Button} from "@jundao/design";

<Button>Click
Me < /Button>

✨ All done!

Components

Currently implemented & planned components:

  • Accordion
  • Alert
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Card
  • Chart
  • Checkbox
  • CodeBlock
  • ContextMenu
  • DataGrid
  • DatePicker
  • Divider
  • Drawer
  • Dropdown
  • DropdownMenu
  • Editor
  • Form
  • Grid
  • HoverCard
  • Image
  • Input
  • Label
  • Layout
  • Link
  • Markdown
  • Message
  • Modal
  • Navigation
  • Notification
  • PaceLoader
  • Pagination
  • Popconfirm
  • Progress
  • QRCode
  • Radio
  • Select
  • Sidenav
  • Skeleton
  • Slider
  • Space
  • Spinner
  • Steps
  • Switch
  • Table
  • Tabs
  • Tag
  • Text
  • Timeline
  • TimePicker
  • Title
  • Tooltip
  • Upload

Versioning

Versions 1.x.x should all be considered unstabled and all minor updates may include BREAKING CHANGES even without explicit mention. This direct contradiction to the Semantic Versioning is due to a bad implementation and limitation in semantic-release.

Versions 2.x.x and onwards will be considered stable and adhere to the Semantic Versioning 2.0.0.

Contributing

Before contributing please refer to CONTRIBUTING.md.

All contributions are moderated under the Contributor Covenant Code of Conduct.