Animated symbols and buttons packaged for Sass & CSS. We also provide a builder that gives developers the ability to select their preferred Transformicons and output for finer control.
Switch branches/tags
Nothing to show
Clone or download
Latest commit bc1c849 Nov 1, 2017

README.md

Transformicons

Build Status

What's a transformicon?

It's an animated symbol/button/icon that morphs. We also provide a builder that gives developers the ability to select their preferred Transformicons and output for finer control.

Browser Testing

browserstack

Each intended platform and browser is double and triple checked using BrowserStack. BrowserStack is a cloud-based cross-browser testing tool that enables developers to test their websites across various browsers on different operating systems and mobile devices.

--

Documentation

All of our documentation has been written in markdown and can be directly viewed on our site or under our docs directory of this repo. Feel free to reach out for help in the issue tracker making sure to title your issue as descriptive as possible. Please make sure you've also checked older issues that may relate to your question first before filing in order to avoid bogging down the issue tracker.

--

Contributing

If you would like to contribute to the Transformicons project, please make sure that anything feature related is isolated to a new branch and titled with the name of the feature being developed.

Local installation is dead simple. We use all local files and directories to run this project. This ensures that you, the developer, need not install anything directly or globally to your system. Also, take note we use libsass for preprocessing all of our Sass code.

Install dependencies

$ npm install

Start a server and watch Sass files

$ npm start

Since a Sass coding guidelines document has been established by Hugo, it only seems fitting to abide loosely by it's suggestions. The http://sass-guidelin.es is what we strive towards as we write Sass and we hope you do the same. Enough said.

You'll find all our working files in the dist directory for Transformicons' JavaScript requirement and related Sass. Any markup for the Transformicons objects will be found in the site/templates/includes/tcons directory. We use assemble to build our markup so make sure you're never editing a file with the .html extension. Assemble files use the .hbs file extension. These are the files you should be editing instead.

Before Filing a Report

  • Make an isolated demo
  • List your setup and explain in detail the steps to follow in order to reproduce your bug.

Transformicons Specs

Objects submitted to Transformicons must abide by the following guidelines in order to be accepted into the library…

  • Fully Tested.
  • Proportions must be a maximum of 40px wide and no more than 40px tall.
  • Make sense to users and yourself.
  • If your Transformicon is truly a button please surround the object in a button tag otherwise use a span or div. See our documentation for examples.
  • Provide custom control over color and appearance for traits such as border-radius. This way authors can control the visual aspect to match their design.

--

Noteworthy Mentions

--

Props to @bennettfeely and @SaraSoueidan. Licensed under MIT