Skip to content
This repository has been archived by the owner on Sep 6, 2019. It is now read-only.

stardust-ui/specifications

Repository files navigation

⚠️ MOVED ⚠️

This effort has moved to the W3 as an incubator community group:

See https://github.com/WICG/open-ui


Tip: This repo is in development. Ideas and patterns you'll see here are in-progress. You are encouraged to join in and help shape the foundation of Open UI.

Open UI

🚀 Mission: Maintain an open standard for UI and promote its adherence and adoption.

👥 Audience: The broader UI community including designers, engineers, and managers.

Why?

We identify these issues in the UI community:

  • Effort - Engineers waste countless hours of human effort duplicating work that could be shared.
  • Support - Accessible users are often left with subpar experiences, or are entirely unsupported.
  • Consistency - User experience is often inconsistent and compromised between UIs due to isolated development practices.
  • Portability - The lack of a shared language for UI limits our ability as a community to communicate, collaborate, and share.
  • Timing - UI's have existed long enough to observe and codify a shared standard; the time is right.

Open UI recognizes a large opportunity for the open source community to make a meaningful difference around these issues.

How?

Deliverables

We intend to produce two sets of deliverables: specifications and utilities. These deliverables will be applicable to a wide range of applications, and will be designed to withstand the rapid evolution of technology.

📜 UI Specifications will be pure descriptions of intent, and will be devoid of concrete technological choices and implementation details.

🔧 Utilities will be framework-agnostic.

Focus Areas

Open UI is currently focused on providing deliverables for these areas:

  • UI Component Anatomy
  • Design Language
  • Accessibility
  • State Management
  • Styling

Supporters

We're gathering support from teams and companies who believe in open source and who have a vision for the future of UI's. You can support Open UI by implementing the standards and utilities or by contributing.

Getting started

Make sure you have Node.js version v8 or later installed.

Useful Commands

This list contains the most useful commands. You should run yarn run to see all scripts.

yarn start                 // run doc site

yarn build                 // build docs