-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
54 additions
and
12,047 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
## Quick start | ||
* Clone the repo: `git clone [email protected]:foxieboy/dotstail.git` | ||
* Install with npm: `npm install --save-dev dotstail` | ||
* Or download the [latest release] (https://github.com//foxieboy/dotstail/archive/master.zip) | ||
* Or download the [latest release](https://github.com//foxieboy/dotstail/archive/master.zip) | ||
|
||
## How to use | ||
In other to use dotstail: | ||
|
@@ -15,7 +15,7 @@ In other to use dotstail: | |
dotstail.setDot ({ | ||
'element': '*your element class or id here*', | ||
'letter': 0, | ||
'lines': 4, | ||
'lines': 4 | ||
}); | ||
``` | ||
* Please keep in mind: `letter`, and `line` option are optional, use them if you want to. Also those options must be a `number`, not `string`. | ||
|
@@ -29,9 +29,15 @@ Call the function by `dotstail.setDot ();` | |
## Documentation | ||
* `element`: is your element class/Id | ||
* `letter`: is the number of letter you want to cut out at the end of the last line. | ||
* `line`: is the number of line you want your element to have a `text elipsis` effect. | ||
|
||
* `lines`: is the number of line you want your element to have a `text elipsis` effect. | ||
|
||
## Tree | ||
``` | ||
public/ | ||
└── theme/ | ||
└── js/ | ||
└── dotstail.min.js | ||
``` | ||
## Template full feature list | ||
|
||
* Semantically Correct / Valid HTML Code | ||
|
Oops, something went wrong.