This repository has been archived by the owner on Apr 19, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added guide to add loading messages.
- Loading branch information
1 parent
fc8aaf2
commit e8c132f
Showing
2 changed files
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Loading Messages | ||
|
||
## Overview | ||
|
||
Flexblock uses (arguably) witty loading messages to not only improve the user experience while waiting for the page to load, but also because adding to these messages is easy, and makes a great first contribution! The conde changes to add a new loading message are extremely simple (you just need to add your new message to a list of strings), so that you can focus on the contributing process rather than complex code. This guide will walk you through the steps of adding a new loading message. This guide assumes you have read [CONTRIBUTING.md](CONTRIBUTING.md), and have created your own fork of flexblock. This guide only covers the changes in the code. | ||
|
||
## Adding a New Message | ||
|
||
The loading messages are stored in the file `src/clj/flexblock/views/loading.clj`. Inside there is a var definition that looks something like this: | ||
|
||
```clojure | ||
(def messages | ||
["A fun loading message!" | ||
"Another fun loading message!" | ||
,,,]) | ||
``` | ||
|
||
You can add your loading message by simply adding it to the list. Make sure to keep the list in alphabetical order! | ||
|
||
```clojure | ||
(def messages | ||
["A fun loading message!" | ||
"Another fun loading message!" | ||
"My brand new super awesome loading message!" | ||
,,,]) | ||
``` |