ore-fol-enums

ore-fol-enums
==========

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/braggarts-labo/ore-fol-enums
[bd_travis_url]: http://travis-ci.org/braggarts-labo/ore-fol-enums
[bd_travis_shield_url]: http://img.shields.io/travis/braggarts-labo/ore-fol-enums.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/braggarts-labo/ore-fol-enums
[bd_travis_com_shield_url]: https://api.travis-ci.com/braggarts-labo/ore-fol-enums.svg?token=
[bd_license_url]: https://github.com/braggarts-labo/ore-fol-enums/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/braggarts-labo/ore-fol-enums
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/braggarts-labo/ore-fol-enums.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/braggarts-labo/ore-fol-enums.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/braggarts-labo/ore-fol-enums
[bd_gemnasium_shield_url]: https://gemnasium.com/braggarts-labo/ore-fol-enums.svg
[bd_npm_url]: http://www.npmjs.org/package/ore-fol-enums
[bd_npm_shield_url]: http://img.shields.io/npm/v/ore-fol-enums.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

Enum values for ore-fol

Installation
-----

``bash
$ npm install ore-fol-enums --save
`

Usage
---------

`javascript
'use strict'

const oreFolEnums = require('ore-fol-enums')

`

Values
------

##### IconClasses

| Key | Value |
| --- | ---- |
| SIGNIN_ICON | fa fa-sign-in |
| SIGNOUT_ICON | fa fa-sign-out |
| ADD_ICON | fa fa-plus |
| ABOUT_ICON | fa fa-info-circle |
| LOCALE_ICON | fa fa-globe |
| CHECK_ICON | fa fa-check |
| CLOSE_ICON | fa fa-close |
| USER_ICON | fa fa-user |
| BACK_ICON | ion ion-chevron-left |
| RESIGN_ICON | fa fa-eraser |
| SERVER_ICON | fa fa-server |
| THREAD_ICON | fa fa-list-ul |
| TAG_ICON | fa fa-tags |
| EDIT_ICON | fa fa-pencil |
| POST_ICON | fa fa-photo |
| STAR_ICON | fa fa-star |
| STAR_DISABLED_ICON | fa fa-star-o |
| STAR_SPINNING_ICON | fa fa-spinner fa-spin |
| COMMENT_ICON | fa fa-comment-o |
| COMMENTS_ICON | fa fa-comments-o |
| DISCLOSURE_ICON | fa fa-angle-right |
| ELLIPSES_ICON | fa fa-ellipsis-v |
| REPORT_ICON | fa fa-hand-o-right |
| SHARE_ICON | fa fa-share |
| DESTROY_ICON | fa fa-trash |
| CLEAR_ICON | fa fa-times-circle |
| CRAWL_ICON | fa fa-exchange |
| BAN_ICON | fa fa-ban |
| NEWS_ICON | fa fa-newspaper-o |
| LOCK_ICON | fa fa-lock |
| UNLOCK_ICON | fa fa-unlock |


##### PreferenceFields

| Key | Value |
| --- | ---- |
| REMEMBER_SIGN | sign:remember |
| THREAD_SORT | thread:sort |


##### ServerEvents

| Key | Value |
| --- | ---- |
| ALIVE_EVENT | server:alive |
| RESTART_EVENT | server:restart |


##### SessionFields

| Key | Value |
| --- | ---- |
| SIGNED_SESSION | sign:signed |
| CAPTCHA_SESSION | captcha |
| CLUE_SESSION | recommend:clue |


##### StackNames

| Key | Value |
| --- | ---- |
| INDEX_STACK | stack:index |
| THREAD_STACK | stack:threads |
| TAG_STACK | stack:tags |
| ADMIN_STACK | stack:admin |
| OTHER_STACK | stack:others |
| ONETIME_STACK | stack:onetime |
| MODAL_STACK | stack:modal |


##### StackWays

| Key | Value |
| --- | ---- |
| PUSH_LEFT_WAY | PUSH_LEFT |
| PULL_UP_WAY | PULL_UP |
| NONE_WAY | NONE |


##### TabNames

| Key | Value |
| --- | ---- |
| THREAD_TAB | tab:thread |
| TAG_TAB | tab:tag |
| OTHER_TAB | tab:other |
| NONE_TAB | tab:none |


##### ViewEvents

| Key | Value |
| --- | ---- |
| THREAD_CREATE_EVENT | view:thread:create |
| THREAD_UPDATE_EVENT | view:thread:update |
| THREAD_DESTROY_EVENT | view:thread:destroy |
| POST_CREATE_EVENT | view:post:create |
| POST_UPDATE_EVENT | view:post:update |
| POST_DESTROY_EVENT | view:post:destroy |
| COMMENT_CREATE_EVENT | view:comment:create |
| POST_BAN_EVENT | view:post:ban |
| POST_UNBAN_EVENT | view:post:unban |
| REPORT_CREATE_EVENT | view:report:create |
| REPORT_DESTROY_EVENT | view:report:destroy` |

License
-------
This software is released under the MIT License.

Links
------

+ [ore-fol][ore_fol_url]

[ore_fol_url]: https://ore-fol.com