template-literals

The purpose of this node library is to provide an easy and maintainable way to use existing bootstrap customization tools and generate css exported as string and tagged literals that can easily be integrated into web components.

Versioning

| Bootstrap | Library versions | |-------------|--------------------| | v5.2.x | v1.0.x | | v5.3.x | v2.0.x |

Installation

Install via npm:

npm install @twbs-css/template-literals

Import

Example of importing bootstrap root css as template literal:

import {HostCssTemplateLiteral} from '@twbs-css/template-literals';

Example of importing bootstrap root css as Lit tagged template literal:

import {HostCssTaggedTemplate} from '@twbs-css/template-literals';

Use case

Main use case is to allow easier css for web components (with string literals) and for Lit elements components (with tagged templates).

Example using the string literals in plain web components:

const template = document.createElement('template');
template.innerHTML = `
<style>
    ${HostCssTemplateLiteral}
</style>
<<add rest of html template>>`;

Example using the tagged template literals in Lit element components:

static get styles() {
    return [
        HostCssTaggedTemplate
    ];
}

Bootstrap CSS Layout template literal

The files grid.literal.css.js and its tagged version grid.tagged.css.js are using the default and well-known bootstrap grid system with the default settings. However, since bootstrap v5.1.0 it provides an experimental grid system which is based on CSS grid specification instead. To use this grid system instead of the default one you can use files grid-layout.literal.css.js or its tagged grid-layout.tagged.css.js

Generate bootstrap template literals with different sass variables

After cloning this branch you can:

• Add your variables to one of the existing scss files under src/scss or
• Add a new scss file under src/scss and your logic
  • Edit bootstrap-items.js to add the details so that the generator will know where to pick up the new file

After you are done with the changes, execute npm run build and the generated files are under /dist.

Notes:

• Bootstrap root css will not work in case of web components since :root is only applicable to document.
• You can use the HostCssTemplateLiteral or HostCssTaggedTemplate which is the same as root but will work for web components under shadow dom.
• Type css does not include the entire reboot css so in case you use both reboot and type just make sure type is the last item, so it can override rules.
• Reboot css includes both :root as well as :host media query for prefers-reduced-motion