Miss any of our Open RFC calls?Watch the recordings here! »

minimalist-notation

1.5.19 • Public • Published

Русский

Minimalist Notation

This is the best CSS framework and CSS-preprocessing technology that you will not be able to part with.

Minimalist Notation (MN) is a technology for generating styles based on parsing the markup. In the current version for web applications, the generation is done directly in the CSS. Technology tremendously speeds up the layout process and can be used additionally with traditional technologies, or replace completely those.

The advantage over the traditional technologies of CSS-preprocessing is that the developer gets rid of the need to write CSS. CSS is generated automatically based on the notation and the style generate rules specified by the developer. The developer no longer needs to control which styles are used in his markup and which ones are not, for from now on the styles are generated dynamically only for what is present in the markup.

Example

Input:

<div class="f12 p10 mb10 f14:h cF00<.parent c0F0@mediaName sq40 bg0F0">...</div>

Output:

@media mediaName{
  .c0F0\@mediaName{color:rgb(0,255,0)}
}
.f12{font-size:12px}
.f14\:h:hover{font-size:14px}
.parent .cF00\<\.parent{color:rgb(255,0,0)}
.bg0F0{background:rgb(0,255,0)}
.sq40{width:40px;height:40px}
.p10{padding:10px}
.mb10{margin-bottom:10px}
 

Try this tests:

Try check how this work with using MN Viewer:
https://viewer.minimalist-notation.org/

See default styles docs (minimalist-notation/presets/styles):
https://styles.minimalist-notation.org/

The starter build with Webpack: https://github.com/mr-amirka/mn-get-started


CLI

npm install -g minimalist-notation
mn --compile ./src --output ./dist/styles.css

More about CLI


Usage with Webpack

npm install minimalist-notation --save-dev

Example:

const {MnPlugin} = require('minimalist-notation/webpack-loader');
 
module.exports = {
  /* ... */
  module: {
    rules: [
      {
        /*
         * To hot reload the presets.
         * Connects only to the loader.
         * These does not get into the bundle file.
         *
         * Attention!
         * May be there is a bug when deleting a files,
         * because the files are cached,
         * and the file deletion event is not catching.
         */
        test: /\.mn\.js$/,
        use: [
          {
            loader: 'minimalist-notation/webpack-loader/reload'
          }
        ]
      },
      {
        test: /\.jsx?$/,
        use: [
          {
            loader: "babel-loader",
            options: {
              /* ... */
            }
          },
          {
            loader: 'minimalist-notation/webpack-loader',
            options: {
              id: 'app',
              attrs: { // for jsx parsing
                className: 'class',
                // m: 'm',
              },
            }
          }
        ]
      }
  },
  plugins: [
    new MnPlugin({
      id: 'app',
      attrs: { // for templates (html) parsing
        'class': 'class',
        // m: 'm',
      },
      output: [
        './dist/app.css',
        './public/app.css',
      ],
      template: [
        './src/index.html',
        // './src/other.html',
      ],
      presets: [
        require('minimalist-notation/presets/medias'),
        require('minimalist-notation/presets/prefixes'),
        require('minimalist-notation/presets/styles'),
        require('minimalist-notation/presets/states'),
        // require('minimalist-notation/presets/main'),
        // require('minimalist-notation/presets/normalize'), // normalize.css v8.0.1
        // require('./mn-my-preset'), // custom preset
      ]
    }),
    /* ... */
  ],
  /* ... */
};

Usage with Gulp3

npm install minimalist-notation --save-dev

Example:

const gulp = require('gulp');
const gulpMN = require('minimalist-notation/gulp3');
 
gulp.task('build', function() {
  return gulp.src('./src/**/*.html')
    .pipe(gulpMN('./dest/app.css', {
      // selectorPrefix: '',
      // attrs: {'class': 'class'},
      presets: [
        require('minimalist-notation/presets/medias'),
        require('minimalist-notation/presets/prefixes'),
        require('minimalist-notation/presets/styles'),
        require('minimalist-notation/presets/states'),
        // require('minimalist-notation/presets/main'),
        // require('minimalist-notation/presets/normalize'), // normalize.css v8.0.1
        // require('./mn-my-preset'), // custom preset
      ],
    }))
    .pipe(gulp.dest('./dest/'))
});

More about Gulp3


Runtime

Example:

const mnProvider = require('minimalist-notation');
const mn = mnProvider({
  // selectorPrefix: '',
  presets: [
    require('minimalist-notation/presets/medias'),
    require('minimalist-notation/presets/runtimePrefixes'),
    require('minimalist-notation/presets/styles'),
    require('minimalist-notation/presets/states'),
    // require('minimalist-notation/presets/main'),
    // require('minimalist-notation/presets/normalize'), // normalize.css v8.0.1
    // require('./mn-my-preset'), // custom preset
  ],
});
const onDocumentReady = require('mn-utils/browser/ready');
const stylesRenderProvider = require('mn-utils/browser/stylesRenderProvider');
const styleTagIdPrefix = 'mn.';
const stylesRender = stylesRenderProvider(document, styleTagIdPrefix);
 
mn.emitter.on(stylesRender);
 
onDocumentReady(() => {
  mn.getCompiler('class').recursiveCheck(document);
  mn.getCompiler('m').recursiveCheck(document);
  mn.compile();
 
  console.log('Minimalist Notation:', mn.data);
});

Standalone

Example:

<script>
  (window.mnPresets || (window.mnPresets = [])).push(function(mn) {
    mn({
      fCustom: 'f50',
      fCustomBig: 'f100'
    });
  })
</script> 
<script src="https://minimalist-notation.org/dest/standalone-mn.1.5.17.js" async></script>

Integrating "Minimalist Notation" into React

Example:

const React = require('react');
const {render} = require('react-dom');
 
const reactCreateElementPatch = require('minimalist-notation/browser/reactCreateElementPatch');
const mnProvider = require('minimalist-notation');
const mn = mnProvider({
  // selectorPrefix: '.mn-scope ',
  presets: [
    require('minimalist-notation/presets/medias'),
    require('minimalist-notation/presets/runtimePrefixes'),
    require('minimalist-notation/presets/styles'),
    require('minimalist-notation/presets/states'),
    // require('minimalist-notation/presets/main'),
    // require('minimalist-notation/presets/normalize'), // normalize.css v8.0.1
    // require('./mn-my-preset'), // custom preset
    ...(window.mnPresets || []),
  ],
});
const stylesRenderProvider = require('mn-utils/browser/stylesRenderProvider');
const styleTagIdPrefix = 'mn.';
const stylesRender = stylesRenderProvider(document, styleTagIdPrefix);
 
mn.emitter.on(stylesRender);
 
React.createElement = reactCreateElementPatch(React.createElement, {
  className: 'class',
}, mn);
 
 
class App extends React.Component {
  render() {
    return (
      <div className="tbl c0F0 bg0 w h100vh tc f40">
        <div>
          <div>Hello React!</div>
          <div className="sq10 bgF"></div>
        </div>
      </div>
    );
  }
}
 
render(<App/>, document.getElementById('app'));
 

I would be grateful for your feedback and comments. Write me in a telegram.
With love, your mr.Amirka :)

Are you interested in the development of this project? Do your bit.

Install

npm i minimalist-notation

DownloadsWeekly Downloads

461

Version

1.5.19

License

MIT

Unpacked Size

314 kB

Total Files

49

Last publish

Collaborators

  • avatar