numldesign / Numl

Numl.Design

A UI Design Language, UI Library of Web Components, and Runtime CSS Framework for rapidly building interfaces that follow your Design System 🌈

STORYBOOK | HANDBOOK | REFERENCE | REPL

Intro

• Add a single JS-script to your page, and you are ready to create virtually any interface using only HTML syntax quickly. No bundler, no config, and no frustration.
• Integrate Numl with popular JS-Frameworks. Use it with SSG if you like.
• Use color generation system and styles-to-state bindings to decrease style declarations up to dozens of times compared to plain CSS.
• Easily create your own Design System and UI Kit based on Numl. Example
• Customize your elements at any level: Globally, in context, directly. Use design tokens (Custom Properties) for a more convenient way to customize.
• Remove dozens of UI helper libraries from your project 'cause Numl can do it itself.
• Add your own elements, style attributes, behaviors, design tokens, custom units, and more...
• Use it for free. Contribute if you like it.

Who is Numl for?

• For beginners Use a well-thought-out Design System with automatic Dark Scheme and High Contrast Mode for rapid development of adaptive and accessible UIs. Create new components by nesting or/and styling foundation elements.
• For enthusiastic Customize the Numl Design System to the smallest detail in runtime using HTML. Use behaviors and control system to add simple interactions. Add your favorite framework (Vue.js, Angular, React, Svelte...) for complex logic.
• For experts Use JavaScript API to create elements that follow your Design System on top of the Numl. Integrate Design Tokens into elements to have more control. Add your own unique elements, styles, behaviors, and tokens.

Another UI Framework? Why should I care?

• All-in-one – Numl is both a markup language for rapidly building responsive interfaces and a set of ready-to-use highly-customizable accessible elements. So you can use a single comprehensive tool to compose and style web applications. It's also possible to create simple interactions without writing JS.
• Unique – Numl is based on unique CSS generation technology that allows you to unleash all the power of modern CSS and take all styles under your control.
• DX Focused – Numl is focused on providing the best possible Developer Experience. It has lots of built-in helpers and solutions for routine UI development and its atomic approach is convenient for maintaining and refactoring.
• Universal – Numl is built on top of Web Components, a modern web API to create reusable UI elements, and it's compatible with most modern JS-frameworks. You can use it as is or create lightweight wrappers for your favorite framework to improve DX, SSR and SEO.

Learn more at NUML.DESIGN

Quick Start

Add the following code to your page.

via JsDelivr:

<script type="module" src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.js"></script>

via Skypack:

<script type="module" src="https://cdn.skypack.dev/[email protected]"></script>

That's it! Now you can use all Numl elements and features!

See the installation instructions for more details and other ways to install Numl.

Examples

• Flex playground
• Grid playground
• Markdown converter
• Before/After slider
• Login form validation

Built with Numl

• Cube.js UI Kit by Cube Dev.
• Numl Website (Repo Link) - built with Nuxt and Vue.js.
• Old Numl Landing Page (Repo Link) built with Parcel.
• Old Numl Storybook (Repo Link) built with Vue.js and Webpack.
• Sellerscale – Project Screenshot Light | Project Screenshot Dark | Project Screenshot Light Contrast | Project Screenshot Dark Contrast
• Web Standards Calendar by @KatrinLuna (Repo Link).

Development status (v1)

Current status of development is HERE.

And here is our Discord. (Ask your questions here!)

Browser Support

Numl is tested in the latest two versions of the following browsers:

• Microsoft Edge
• Google Chrome
• Mozilla Firefox
• Apple Safari
• Apple iOS Safari
• Google Android

Critical bug fixes in earlier versions will be addressed based on their severity and impact.

If you need to support IE11 or pre-Chromium Edge, this library isn't for you. Although web components can (to some degree) be polyfilled for legacy browsers, supporting them is outside the scope of this project. If you're using Numl in such a browser, you're gonna have a bad time.

Development

• npm start run Numl Playground.
• npm run build build the library to dist:
  • dist/index.js - ES6 tree-shaking friendly module. (Exports global Nude object)
• npm run dev build the library, then keep rebuilding it whenever the source files change.
• npm run test run tests.

Local playground

Run npm start to view test page with few examples.

Roadmap v1

• More documentation
• More examples
• More tests
• TRL Support
• Improved Behavior System
• Figma UI Kit 🌟 (Coming Soon)
• Theme Builder 🌈 (Coming Soon)
• Numl-React UI Library 🤖

See our Changlelog.

Contribution

We are looking for contributors!

Numl is a big and ambitious project with open source that it has a unique approach in UI development.

Join us, and we'll make the Web better for everyone!

If you want to join us or leave some feedback write to this email: [email protected]

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Andrey Yamanov 💻 🐛 💼 🎨 📖 🤔 ⚠️

Shubham Kaushal 🐛 💼 🎨 📖 🤔 ⚠️

Nurbek Akhmedov ⚠️ 🐛 🤔

katrinLuna 📖 ⚠️ 🐛 🤔

Dmitry Patsura 📖

Andrey Skladchikov 🐛 🤔

Leonid Yakovlev 🤔 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT