Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ullfis/aurelia-mdc-bridge
Aurelia Mdc Bridge is a collection of wrappers for Material Design Components.
https://github.com/Ullfis/aurelia-mdc-bridge
aurelia aurelia-cli css javascript material material-components material-design pug typescript web
Last synced: about 2 months ago
JSON representation
Aurelia Mdc Bridge is a collection of wrappers for Material Design Components.
- Host: GitHub
- URL: https://github.com/Ullfis/aurelia-mdc-bridge
- Owner: Ullfis
- License: mit
- Created: 2017-07-23T20:26:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-15T23:31:09.000Z (about 2 years ago)
- Last Synced: 2024-10-30T02:36:51.280Z (about 2 months ago)
- Topics: aurelia, aurelia-cli, css, javascript, material, material-components, material-design, pug, typescript, web
- Language: HTML
- Homepage: https://ullfis.github.io/aurelia-mdc-bridge
- Size: 3.58 MB
- Stars: 17
- Watchers: 8
- Forks: 12
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-material-design - Aurelia mdc bridge - Material Design Components for the web port to aurelia (Aurelia / Components)
README
# Aurelia Mdc Bridge
[Project page](https://ullfis.github.io/aurelia-mdc-bridge) | [GistRun](https://gist.run/?id=7e9a439b81c17ac94e40409cb1f4b14d)
_This plugin is in active development and your feedback is welcome_
### What is Aurelia Mdc Bridge?
Aurelia Mdc Bridge is a collection of wrappers for Material Design Components. You can easy use components and data-bind properties using Aurelia as your client framework.
### What is Aurelia?
[Aurelia](http://aurelia.io) is a JavaScript client framework for mobile, desktop and web leveraging simple conventions and empowering creativity.
### What is Material Components?
[Material Components](https://material.io/components/web/) provide a reliable development environment for apps and websites across Android, iOS, and the web.
Components are updated as the Material Design system evolves, ensuring consistent pixel-perfect implementation and adherence to Google’s front-end development standards, such as internationalization and accessibility support.
## Getting started
- Create a new or use an existing project with aurelia-cli.
```bash
au new material-test
...
cd material-test
```
- Install aurelia-mdc-bridge:
```bash
au install aurelia-mdc-bridge
```
- Include Material Design icons and fonts in index.html:
```html
...
```
- Register the plugin in your main.js in src folder:
```javascript
export function configure(aurelia) {
...
aurelia.use.plugin('aurelia-mdc-bridge')
...
}
```
- Import the css in your app.html:
```html
```
- Use it:
```html
Username
Submit
```
```bash
au run -w
```
- Check out [project page](https://ullfis.github.io/aurelia-mdc-bridge) to add more components to your project.
## Build from source
Install dependencies:
```bash
npm install
```
Build and watch
```bash
npm start
```
Lint
```bash
npm run lint
```
Build only bridge components (production):
```bash
npm run build
```
Build only docs (production):
```bash
npm run docs
```
Build bridge, docs, update changelog and git add all changes (production)
```bash
npm run release
```
### Tests
Visual and console. No tests has been created yet. Contribute?
# Pull Requests
Yes, please!
[Guidelines](https://github.com/Ullfis/aurelia-mdc-bridge/blob/master/CONTRIBUTING.md)