Skip to content

Commit

Permalink
updated README, replacing docs with auto-built ones from gh-pages.
Browse files Browse the repository at this point in the history
  • Loading branch information
Vermel, Runn (GE Global Research) committed Apr 11, 2016
1 parent 7bd90bc commit 0bdb097
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 86 deletions.
File renamed without changes.
91 changes: 7 additions & 84 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Px-Alert-Message
#Px-Alert-Message
-----------------------------------------------

## Overview

Px-Alert-Message is a Predix Experience ('Px') component that appears in a queue within the message container.
Px-Alert-Message is a Predix UI component that appears in a queue within the message container.

## Usage

Expand All @@ -20,7 +20,7 @@ Node, npm and bower are necessary to install the component and dependencies. web
First, install the component via bower on the command line.

```
bower install https://github.com/PredixDev/px-alert-message.git --save
bower install px-alert-message --save
```

Second, import the component to your application with the following tag in your head.
Expand All @@ -44,91 +44,12 @@ Finally, use the component in your application:
<br />
<hr />

## Attributes

#### type

*Type:* **String** - (*Optional*) - *Default:* "information"

Type defines the alert level; this is reflected in the icon.
```
'important' - red triangle labeled 1
'warning'- orange diamond labeled 2
'error' - yellow square labeled 3
'information' - blue circle labeled 4
'custom' - allows a developer to specify HTML incluing images in place of the icon.
'more' - allows for a message that shows that there are more messages.
```
```
<px-alert-message
...
type="information">
</px-alert-message>
```
#### message-title

*Type:* **String** - (*Optional*) - *Default:* ""

The title that is displayed bold in the message area of the alert box.

```
<px-alert-message
...
message-title="Heads up!">
</px-alert-message>
```

#### message

*Type:* **String** - (*Optional*) - *Default:* ""

The message body that is displayed after the message-title in the message area of the alert box.

```
<px-alert-message
...
message="This definitely needs our attention.">
</px-alert-message>
```

#### action

*Type:* **String** - (*Optional*) - *Default:* null

User interaction on the right hand side of the message box.
```
'dismiss' - displays the (x) control to dismiss
'acknowledge' - displays the (OK) button to dismiss
'URL' - string containing http url to be opened, displays the (Open) button.
```
```
<px-alert-message
...
action="https://www.predix.io/">
</px-alert-message>
```

#### auto-dismiss

*Type:* **Number** - (*Optional*) - *Default:* null

A delay in milliseconds before an alert message is dismissed automatically.

```
<px-alert-message
...
auto-dismiss="5000">
</px-alert-message>
```


<br />
<hr />
## documentation

Read the full API and view the demo [here](https://predixdev.github.io/px-alert-message).

## Local Development


From the component's directory...

```
Expand Down Expand Up @@ -203,3 +124,5 @@ GE Coding Style Guide


### Known Issues

Please use [Github Issues](https://github.com/PredixDev/px-alert-message/issues) to submit any bugs you might find.
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "px-alert-message",
"version": "v0.3.2",
"version": "v0.3.3",
"main": [
"px-alert-message.html"
],
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "px-alert-message",
"author": "General Electric",
"description": "A Px component",
"version": "v0.3.2",
"version": "v0.3.3",
"private": true,
"extName": null,
"repository": {
Expand Down

0 comments on commit 0bdb097

Please sign in to comment.