Skip to content
This repository has been archived by the owner on Sep 16, 2020. It is now read-only.

FriendsOfTrowel/Buttons

Repository files navigation

Friends of Trowel

Trowel-buttons

npm version Bower version

The official Trowel Component for Buttons buttons is a Trowel Component, please refer to the Trowel doc for more informations about how works Trowel Components

Getting Started

Download

You can easily install trowel-buttons by using NPM or Bower with the name trowel-buttons (previously friendsOfTrowel-buttons-component)

# With bower
$ bower install trowel-buttons

# With npm
$ npm install trowel-buttons

# With yarn
$ yarn add trowel-buttons

You can also download a zip archive right here.

Installation

SCSS

The main scss file to include to your main .scss file is located at the ./src/scss/buttons.scss. As a Trowel Component, it also requires two dependencies to compile the scss code. Here an scss installation snippet.

// Trowel Dependencies
@import './path/to/dependencies/sassy-maps/sass/sassy-maps';
@import './path/to/dependencies/trowel-core/src/trowel';

// Trowel Component Buttons
@import './path/to/dependencies/trowel-buttons/src/scss/buttons.scss';

Twig files

The twig file is located at the ./src/twig/buttons.html.twig.

Usage

to be written

License

MIT © Trowel