wired-elements README

The project's README from github.com/rough-stuff/wired-elements. As one markdown file: README.md.

wired-elements 👉 wiredjs.com

Wired Elements is a series of basic UI Elements that have a hand drawn look. These can be used for wireframes, mockups, or just the fun hand-drawn look.

alt Preview

Try now

Play with wired-elements:

Wired Elements

Try it with a framework

Wired Elements in React

Wired Elements in Vue

Wired Elements in Svelte

Install

The package (wired-elements) exports all components in the wired category. List of all wired elements can be found here.

Add wired-elements to your project:

npm i wired-elements

Or load the ES module directly through unpkg

<script type="module" src="https://unpkg.com/wired-elements?module"></script>

Usage

Import into your module script:

import { WiredButton, WiredInput } from "wired-elements"

or

import { WiredButton } from 'wired-elements/lib/wired-button.js';
import { WiredInput } from 'wired-elements/lib/wired-input.js';

Use it in your HTML:

<wired-input placeholder="Enter name"></wired-input>
<wired-button>Click Me</wired-button>

Learn about web components here.

Component API

To view details of each component - properties, events, css-properties, etc, are provided in the docs folder.

Demo

Demo of all components is available at wiredjs.com.

Credits

wired-elements was built using RoughJS and Lit.

Contributors

Become a sponsor of the Rough suite of libraries

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

MIT License (c) Preet Shihn

wired-elements (rough-stuff/wired-elements)

Searching Database…

Что это такое?Wired Elements — это набор пользовательских веб-компонентов с рисованным от руки стилем. Они полезны для вайрфреймов, макетов или просто для необычного, эскизного оформления интерфейса.
Это фреймворк или обычная библиотека компонентов?Это библиотека веб-компонентов, построенных на стандартах и созданных с помощью Lit. Их можно сразу использовать в HTML, React, Vue или Svelte, не переходя на какой-либо фреймворк.
Как мне добавить это в проект?Установите пакет 'wired-elements' в проект или загрузите ES-модуль напрямую через unpkg. Затем импортируйте его в свой модульный скрипт и используйте теги в HTML.
На что эта библиотека опирается внутри?Она построена на основе Lit (для слоя веб-компонентов) и RoughJS (для эффекта рисования от руки).
Есть ли готовые обёртки для конкретных фреймворков?Основной пакет не привязан к какому-либо фреймворку, но есть отдельные примеры и обёртки для использования с React, Vue и Svelte.
Кто этим пользуется?Дизайнеры и разработчики, которым нужны быстрые упрощённые макеты интерфейса или вайрфреймы без ручного рисования.
Какие элементы интерфейса входят в пакет?Он включает базовые элементы интерфейса: кнопки, чекбоксы, слайдеры, карточки, диалоговые окна и похожие стандартные элементы управления. Каждый из них отрисован в эскизном стиле от руки.
Где посмотреть живую демонстрацию?Полная демонстрация всех компонентов доступна на wiredjs.com — официальном сайте проекта.
Можно ли использовать с React, Vue или Svelte?Да. Поскольку компоненты являются стандартными веб-компонентами, проект предоставляет примеры их использования внутри приложений на React, Vue и Svelte.
Size
1.9 MB
Stars
10.8K
Age
9y
Commits · 90 Days