Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
F
feather
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Kulya
feather
Commits
c1f40d07
Unverified
Commit
c1f40d07
authored
Dec 12, 2017
by
Cole Bemis
Committed by
GitHub
Dec 12, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: Update README.md
parent
ad8fabb5
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
3 deletions
+9
-3
README.md
README.md
+9
-3
No files found.
README.md
View file @
c1f40d07
...
...
@@ -164,7 +164,7 @@ See the [API Reference](#api-reference) for more information about the available
### `
feather.icons
`
An object with
information
about every icon.
An object with
data
about every icon.
#### Usage
...
...
@@ -172,7 +172,7 @@ An object with information about every icon.
feather.icons.x
// {
// name: 'x',
// contents: '<line ... /><line ... />
`
,
// contents: '<line ... /><line ... />
'
,
// tags: ['cancel', 'close', 'delete', 'remove'],
// attrs: {
// class: 'feather feather-x',
...
...
@@ -189,11 +189,13 @@ feather.icons.x
// }
feather.icons.x.toString()
// '<line ... /><line ... />
`
// '<line ... /><line ... />
'
```
[View Source](https://github.com/colebemis/feather/blob/master/src/icons.js)
---
### `
feather.icons
[
name
]
.toSvg(
[
attrs
]
)
`
Returns an SVG string.
...
...
@@ -219,6 +221,8 @@ feather.icons.circle.toSvg({ class: 'foo bar' })
[View Source](https://github.com/colebemis/feather/blob/master/src/icon.js)
---
### `
feather.replace(
[
attrs
]
)
`
Replaces all elements that have a `
data-feather
` attribute with SVG markup corresponding to the element's `
data-feather
` attribute value.
...
...
@@ -275,6 +279,8 @@ All attributes on the placeholder element (i.e. `<i>`) will be copied to the `<s
[View Source](https://github.com/colebemis/feather/blob/master/src/replace.js)
---
### [DEPRECATED] `
feather.toSvg(name,
[
attrs
]
)
`
> **Note:** `
feather.toSvg()
` is deprecated. Please use `
feather.icons
[
name
]
.toSvg()
` instead.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment