Giter Club home page Giter Club logo

iremono's Introduction

Iremono

Iremono is a semi-atomic CSS styling kit for designing in code.

Note well

This is a work in progress. I will be actively updating it in use on current projects. Expect breaking changes. These notes are not even up-to-date…

How to use it

  1. Install: yarn add callumflack/iremono or npm i callumflack/iremono.

  2. Iremono uses postcss. Install the deps: yarn add postcss-mixins postcss-easy-import postcss-preset-env

  3. Create a variables file. See variables.example.css. This lists all the css custom properties used. You can customise everything in iremono from this file.

  4. Import your variables.css and iremono into your CSS index file, as described below. The order of imports matters: add your variables first, then font-faces (if required), and then iremono. Theme stylings should be last. This way, all utilities and mixins within iremono will be available to use in your theme css as well.

/* Variables */
@import "./variables.css";

/* Font faces, if you wish */
@import "./typography/font-face.css";

/* Iremono */
@import "iremono/index.css";

/* Theme your website… */
@import "./theme/button.css";
  1. Finally, this postcss library makes use of postcss-mixins, postcss-easy-import and postcss-preset-env. Manage their config with a postcss.config.js file, an example of which is provided in this repo.

Documentation

Some form of documentation will be done in time. The best way to check it out is to download it and have a play. Here's a few opionated techniques I've used:

  1. Responsive typography using ems against a body font-size in rems, whose value is updated at media queries.
  2. Updating the value of css custom properties in media queries. This means I can manage things like white space responsively with a single line of css that holds a single custom variable. No complicated and tediously managed media queries.
  3. The most used utilities are name-spaced with their type's initial letter. For example, width classes start with w-. But not every utility is namespaced this way. I don't want to remember too much to use the system.

What does Iremono mean?

Iremono means "vessel" or "container" in Japanese. I don't speak Japanese, but I came across it serendipitously and I liked how it incorporates the word "mono". I wanted to create a standalone set of CSS patterns I could just drop in to any project. So in my naive dot-connecting way, a "mono vessel" sounded right. The name has stuck for some time.

iremono's People

Contributors

callumflack avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.