# platform-ui-components

> A collection of reusable UI components used across various applications built by the Platform team.

Latest version **0.0.12** (published 2016-03-30) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install platform-ui-components
pnpm add platform-ui-components
yarn add platform-ui-components
bun add platform-ui-components
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.12 |
| Published | 2016-03-30 |
| First published | 2016-03-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | heavysixer |
| Keywords | angular, material, material design, browser, Sphero, client-side |

## Links

- npm: https://www.npmjs.com/package/platform-ui-components
- Repository: https://github.com/OrbotixInc/platform-ui-components
- Issues: https://github.com/OrbotixInc/platform-ui-components/issues
- npm.io page: https://npm.io/package/platform-ui-components

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.12 (latest) — 2016-03-30
- 0.0.11 — 2016-03-30
- 0.0.10 — 2016-03-30
- 0.0.9 — 2016-03-30
- 0.0.8 — 2016-03-30
- 0.0.7 — 2016-03-30
- 0.0.6 — 2016-03-30
- 0.0.5 — 2016-03-30

## README

# platform-ui-components

A collection of reusable UI components used across various applications built by the Platform team.

These components depend on the Google's Angular 1.x JS implementation of their
Material Design spec. Where possible we have followed the Material Design spec
to the letter.

Since these are private modules for now you will need to install them using a fully qualified url:

```shell
bower install https://github.com/OrbotixInc/platform-ui-components.git
```

## <a name="releasing"></a> Our Release Processes

This project follows the SemVar versioning process which can be described in the following manner.

*  `major` :  Fundamental changes to the nature of the project, which would constitute a major reworking of the codebase.
*  `minor`:  aka `master` contains patch release changes AND breaking changes and new features
*  `patch`:  non-breaking changes (no API, CSS, UX changes that will cause breaks in existing `spheroPlatform` applications)

##### Patch Releases

The patch builds (1.0.4, 1.0.5, 1.0.6) are prepared based on commits in the `patch` branch; which contains only non-breaking changes (eg bug fix, some API additions, minimal non-breaking CSS changes ).  We will be building `patch` releases every week.

##### Minor Releases

The minor build (1.1.0, 1.2.0, 1.3.0,...) are prepared based on commits in the `master` branch; which will remain the daily development branch AND will be the source for the `minor` releases.

Our formal release of `minor` builds is much less frequent; probably 1x / Quarter. Developers can easily obtain the latest, full change-set from bower or npm using references to `@master`.


## <a name="building"></a> Building

Developers can easily build spheroPlatform using NPM and gulp.

First install or update your local project's **npm** tools:

```bash
# First install all the NPM tools:
npm install

# Or update
npm update
```

Then run the **gulp** tasks:

```bash
# To build `platform-ui-components.js/.css` files in the `/dist` directory
gulp build

# To release a new version
gulp release
```

Once you have all the necessary assets installed, add `spheroPlatform` as a dependency for your app:

```javascript
angular.module('myApp', ['spheroPlatform']);
```

---
_Source: https://npm.io/package/platform-ui-components · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
