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 是一组自定义 Web 组件,外观采用手绘风格,适用于线框图、原型图,或者只是想要一种有草稿感的趣味界面效果。
它是框架还是普通的组件库?它是一个基于标准的 Web 组件库,使用 Lit 构建,因此你无需采用任何框架,就能直接将这些组件用在 HTML、React、Vue 或 Svelte 中。
怎么把它添加到项目中?将 'wired-elements' 包安装到你的项目中,或直接通过 unpkg 加载 ES 模块,然后在模块脚本中导入,并在 HTML 中使用这些标签。
它底层依赖什么?它构建于 Lit(负责 Web 组件层)和 RoughJS(负责手绘渲染效果)之上。
它是否提供针对特定框架的封装?核心包与框架无关,但另外提供了示例或封装方案,展示了如何在 React、Vue 和 Svelte 中使用它。
谁会用到它?想要快速制作低保真风格 UI 原型图或线框图、又不想手动绘制的设计师和开发者。
这个包包含哪些 UI 元素?它涵盖按钮、复选框、滑块、卡片、对话框等基础 UI 构件以及类似的标准控件,每个都采用草稿式手绘风格呈现。
在哪里可以看到在线演示?所有组件的完整演示可在项目官方网站 wiredjs.com 上查看。
我可以在 React、Vue 或 Svelte 中使用它吗?可以。由于这些组件是标准 Web 组件,项目提供了在 React、Vue 和 Svelte 应用中使用它们的具体示例。
Size
1.9 MB
Stars
10.8K
Age
9y
Commits · 90 Days