pwix:plus-button

What is it

A simple Blaze component for Meteor which provides a circled-'+' button.

Why this package?

Well because we cannot just copy a Blaze component in each and every package or application which would need it:

• first, because this is always a bad idea to just duplicate code, as this obviously also duplicates maintenance efforts and bugs
• second, because Blaze has a single namespace per application, and so refuses to have a duplicated component name.

This is a client-only package.

Usage

Very simple:

Include in your HTML template

    {{> plusButton }}

Handle the event in your JS code

    'click .plusButton'( event, instance ){

    }

Configuration

None at the moment.

Provides

The package exports the PlusButton global object.

Blaze components

plusButton

A simple circled-'plus' button.

The component is configurable with an object passed as an argument, which may contain:

• classes:

  The classes to set on the button element.

  Defaults to btn btn-primary.

• enabled:

  A ReactiveVar.

  If provided, then the button will be enabled (resp. disabled) if the ReactiveVar evaluates as truthy (resp. falsy).

  When not provided, the button is enabled.

• label:

  The label of the displayed button as a HTML string.

  Defaulting to a big plus '+'.

• shape:

  The shape of the displayed button.

  Allowed values are:

    - `PlusButton.C.Shape.CIRCLE`
    - `PlusButton.C.Shape.RECTANGLE`
  

  Defaults to PlusButton.C.Shape.CIRCLE.

• title:

  The title of the displayed button as a string.

  No default.

NPM peer dependencies

This package has no NPM dependencies.

---

P. Wieser

• Last updated on 2024, Oct. 4th