Git Product home page Git Product logo

ember-divider-dots's Introduction

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

ember-divider-dots's People

Contributors

briansipple avatar ember-tomster avatar

Stargazers

Michael Swanson avatar Denys Slipetskyy avatar Martinez Andres avatar Alexander avatar  avatar Ilya Radchenko avatar Stefan Rotariu avatar

Watchers

 avatar James Cloos avatar

ember-divider-dots's Issues

Potential features to add

  • Per-dot sizing/coloring/etc

  • Multiple justify settings:

    • start
    • end
    • center
    • between
    • around
  • Multiple "dot" types

    • Squares
    • Diamonds
    • "Compose your own"?
  • Global Configuration of divider settings

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.