Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 2.55 KB

README.md

File metadata and controls

78 lines (61 loc) · 2.55 KB
Raw

Yew Styles

Crate Info API Docs Discord Chat

Yew Styles is a style framework for yew

Motivation

The purpose of developing this project is first, provide a style framework for yew because there isn't not many options currently, also to create a layout system which is not far of the flexbox concept, and, to take the rust benefits and implement a properties selected by enumeration in the most of the cases which makes fast for developing applications and avoids the practice try and error

How it works

Each component is split in two parts, the logical yew component and its sass module, however, it is not necessary to worry about the sass module only it needs to be include in the project

How install it

  1. Install the sass module: npm install yew-styles
  2. Add the yew_style crate with the features needed for your project in Cargo.toml file:
yew_styles = { version="0.5.1", features=["button", "navbar", "layouts"] }
  1. Import the main.css file in you main javascript/typescript file project:
    import 'node_modules/yew-styles/main.css';
  1. Ready to import and use in your project 🚀

Run the documentation page

  1. git clone https://github.com/spielrs/yew_styles.git
  2. cd yew_styles
  3. npm start

In the left side there is a list of links where each one access to a correspondent component documentation, there, shows how to use it.

Rust Docs

You can also see all the yewstyle documentation in rust docs here. It include description and examples for each component

Run the tests

Inside of the project run:

cargo test --target wasm32-unknown-unknown --manifest-path=crate/yew_styles/Cargo.toml

Development phase

Yew style is in early phase, currently doesn't have enough components to cover all the requirements that could need a website/web application. All contributions are appreciated.

Roadmap

  • Button
  • Layout
  • Navbar
  • Form
  • Card
  • Text
  • Table
  • Pagination
  • Modal
  • Sidebar
  • Tab
  • Tooltips
  • Calendar
  • Assets

License

Yew Style is MIT licensed. See license