https://github.com/wiredjs/wired-elements
Collection of custom elements that appear hand drawn. Great for wireframes or a fun look.
https://github.com/wiredjs/wired-elements
lit-element lit-html prototyping web-components webcomponents wireframe wireframes
Last synced: 8 months ago
JSON representation
Collection of custom elements that appear hand drawn. Great for wireframes or a fun look.
- Host: GitHub
- URL: https://github.com/wiredjs/wired-elements
- Owner: rough-stuff
- License: mit
- Created: 2017-08-28T06:12:03.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-07T20:59:18.000Z (about 2 years ago)
- Last Synced: 2024-10-29T14:54:52.610Z (about 1 year ago)
- Topics: lit-element, lit-html, prototyping, web-components, webcomponents, wireframe, wireframes
- Language: TypeScript
- Homepage: https://wiredjs.com
- Size: 1.83 MB
- Stars: 10,516
- Watchers: 129
- Forks: 329
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome - wired-elements - Collection of elements that appear hand drawn. Great for wireframes. (Design/UI)
- awesome-web-components - Wired Elements - Set of common UI elements with a hand-drawn, sketchy look. (Real World / Component Libraries)
README
# wired-elements 👉 [wiredjs.com](https://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.
## Try now
Play with wired-elements:
[Wired Elements](https://codesandbox.io/s/wired-elements-vanilla-4bpny)
#### Try it with a framework
[Wired Elements in React](https://codesandbox.io/s/xrll5wyl8w)
[Wired Elements in Vue](https://codesandbox.io/s/vj389y9375)
[Wired Elements in Svelte](https://codesandbox.io/s/wired-elements-svelte-4hfkb)
## Install
The package (wired-elements) exports all components in the **_wired_** category. List of all wired elements can be found [here](https://github.com/rough-stuff/wired-elements/tree/master/src).
Add wired-elements to your project:
```
npm i wired-elements
```
Or load the ES module directly through unpkg
```html
```
## Usage
Import into your module script:
```javascript
import { WiredButton, WiredInput } from "wired-elements"
```
or
```javascript
import { WiredButton } from 'wired-elements/lib/wired-button.js';
import { WiredInput } from 'wired-elements/lib/wired-input.js';
```
#### Use it in your HTML:
```html
Click Me
```
Learn about web components [here](https://developer.mozilla.org/en-US/docs/Web/Web_Components).
## Component API
To view details of each component - properties, events, css-properties, etc, are provided in the [docs folder](https://github.com/rough-stuff/wired-elements/tree/master/docs).
## Demo
Demo of all components is available at [wiredjs.com](https://wiredjs.com/showcase.html).
## Credits
wired-elements was built using [RoughJS](https://roughjs.com/) and [Lit](https://lit.dev/).
## Contributors
Become a sponsor of the [Rough suite of libraries](https://github.com/rough-stuff)
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/rough/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/rough/contribute)]
## License
[MIT License](https://github.com/rough-stuff/wired-elements/blob/master/LICENSE) (c) [Preet Shihn](https://twitter.com/preetster)