ember-divider-dots

0.1.0 • Public • Published

ember-divider-dots

A customizable Ember component for rendering SVG section dividers.

Latest NPM release CircleCI Build Status

Ember Observer Score License Dependencies Dev Dependencies

Installation

ember install ember-divider-dots

Usage

For usage tips and visible examples, check out the Ember Divider Dots demo app.

Container Component Attributes

  • numDots

    • The number of dots to render as the divider.
    • type: Integer
    • default: 4
  • lineWidth

    • A value accepted by the SVG width attribute.
    • type: String
    • default: '100%'
  • lineHeight

    • A value accepted by the SVG height attribute.
    • type: String
    • default: '100%'
  • direction

    • Layout direction of the dots (AKA "flow" direction).
    • type: String
    • options: horizontal, vertical
    • default: horizontal
  • dotType

    • The type of SVG to render as a "dot" (see the [demo page] for visual representations).
    • type: String
    • options: circle, square
    • default: circle
  • crossSizePct

    • The size of each dot as a percentage of the cross size ("cross size" being the amount of space in the direction opposite the layout direction)
    • type: Number
    • default: 100
  • gapSizePct

    • The size of each gutter (the space between two dots), given as a percentage of the dotSize.

      Note: This will have no effect when justify is set to between, as the gutter space will be automatically distributed.

    • type: Number

    • default: 125

  • fill

    • Binding for the SVG fill attribute.
    • type: String
    • default: currentColor
  • justify

    • The alignment of each dot along its main axis.
    • options: start, center, end, between
    • type: String
    • default: center

Background

Section divider "dots" are a common design pattern, and they can add a nice touch to long, content-heavy pages.

But implementing them is tough!

There's a wide variety of ways to approach their markup and styling, and if you want to use SVG (good for you!), the calculus for sizing and positioning gets even more involved.

And so as simple as they seem, divider dots are often overlooked.

That's where Ember Divider Dots comes in. The addon provides an easy-to-use, easy-to-configure component that generates a line of "dots" as crisp SVGs wherever you choose to place it.

Contributing

Dot Type Requests

If you have a request for a new dot type, please feel free to open up an issue for it.

Developing

Setup

  • git clone <repository-url> this repository
  • cd ember-divider-dots
  • npm install
  • bower install

Running

Running Tests

  • npm test (Runs ember try:each to test your addon against multiple Ember versions)
  • ember test
  • ember test --server

Building

  • ember build

Package Sidebar

Install

npm i ember-divider-dots

Weekly Downloads

1

Version

0.1.0

License

MIT

Last publish

Collaborators

  • bsipple