0.21.0 • Published 5 years ago

@minna-ui/pre-markup v0.21.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 years ago

NPM version Licence

@minna-ui/pre-markup

Svelte markup preprocessor for use in Minna UI projects. Optimise HTML before it hits Svelte for smaller output. Primarily this trim excessive white space but you can enable the unsafe option for advanced optimisations.

Usage

Install

yarn add -D @minna-ui/pre-markup

Quick start

Add both @minna-ui/pre-markup and @minna-ui/pre-style with default settings to your Svelte compile options:

const svelte = require('svelte');
const { preprocess } = require('minna-ui');

svelte({ preprocess });

Custom configuration

Add to your Svelte compile options:

const svelte = require('svelte');
const preMarkup = require('@minna-ui/pre-markup');

const dev = process.env.NODE_ENV === 'development';

svelte({
  preprocess: {
    // disable for better feedback during development
    markup: preMarkup({ level: dev ? 0 : 3 }),
  },
});

Known issues

You must wrap {} tags in quotes when there are { or } characters inside the tag. The exception to this is when using spread attributes (e.g. {...child.props}) in which case you must not use quotes.

Incorrect:

<MinnaNavbar segment={child.segment} menuItems={[
  { url: 'example', name: 'Example' },
]}/>

Correct (with " around { }):

<MinnaNavbar
  segment="{child.segment}"
  menuItems="{[
  { url: 'example', name: 'Example' },
]}"
/>

Options

NameDefaultTypeDescription
unsafeWhitespacefalseBooleanCollapse all whitespace between tags (instead of leaving a single space). When using this option you may need to manually add spaces, {' '}, around inline elements such as links.
unsafefalseBooleanEnable aggressive and potentially dangerous optimisations.
*undefinedAnyAny other options you pass in will override the default html-minifier options. See the html-minifier docs for more info.

Licence

@minna-ui/pre-markup is part of Minna UI, an Apache-2.0 licensed open source project. See LICENCE.


© 2019 We Are Genki