eeschimosu / material-remixer-web

Remixer web framework

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

remixer

Build Status codecov npm version

Remixer helps teams use and refine design specs by providing an abstraction for these values that is accessible and configurable from both inside and outside the app itself.

This SDK for Web is currently in development.

New to Remixer? Visit our main repo to get a full description of what it is and how it works.


Quickstart

1. Use npm to install as dependency.

npm install material-remixer --save

This will install the Remixer files in your project's node_modules folder.

2. Include the remixer.js script in your app.

<head>
  <script src="./node_modules/material-remixer/dist/remixer.js"></script>
</head>

3. Begin by starting Remixer

remixer.start();

4. Add variables

Now you can add any desired variables and use the callback method to assign the selectedValue property.

// Add a boolean variable to generate a toggle switch in the overlay.
remixer.addBooleanVariable("show", true, function(variable) {
  document.getElementById("box").style.display = variable.selectedValue ? "block" : "none";
});

Example App

State of development

Visit our State of Development wiki for the current roadmap and status of development for each platform.

Other Repositories

The main Remixer GitHub repo for documentation, project tracking, and general information:

Other platform specific libraries and tools can be found in the following GitHub repos:

  • iOS - Remixer for iOS.
  • Android - Remixer for Android.
  • Web Remote - Remixer web remote controller for all platforms (available soon).

Is material-foundation affiliated with Google?

Yes, the material-foundation organization is one of Google's new homes for tools and frameworks related to our Material Design system. Please check out our blog post Design is Never Done for more information regarding Material Design and how Remixer integrates with the system.

Contributing

We gladly welcome contributions! If you have found a bug, have questions, or wish to contribute, please follow our Contributing Guidelines.

License

© Google, 2016. Licensed under an Apache-2 license.

About

Remixer web framework

License:Apache License 2.0


Languages

Language:TypeScript 91.9%Language:CSS 4.0%Language:JavaScript 3.4%Language:HTML 0.7%