octicons_v2 0.0.0.pre.61b6959 → 0.0.0.pre.064e3ab

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e9c6f93e0dc52804b5632a820d6bda82bca7399ab867c29bd4d9c6ca3678c5b5
4
- data.tar.gz: 1bf65bb1fdc29884874621ddebdbd30a226ecee09e6b2dde185ab9b9d1526504
3
+ metadata.gz: b120039b899403bd48ddb147af47638a31327ff14587c0e21eb416c82a19affc
4
+ data.tar.gz: f2e09f0e73662d49a48c48a6d778b18a627385827780c3b877890acc1cdf2d94
5
5
  SHA512:
6
- metadata.gz: f7490c61f8ae3d136526a3c98a97d9c57821a7a36681e571af68dcb01ff2801c2e1d7c7aa2fdb365a2c5e6b17e23f0fc7d1a2bc73b5a3fd00ead23b2b6394a9c
7
- data.tar.gz: f4185e0c9e01f37a1b07e732ed661e89e36626d19c7c1b4dd504da51958ff6ec093c30871e049d4a608e4166f492e9c896256931557b9943c2533a17f9ae97e9
6
+ metadata.gz: 55e569080bab3d22b554d832479683144f62b238a3ee010fb409e44ad1615531a3cf0d8ccb2d291c3eb4dd6cefd2dd7c826b352b964334aecf877aaa5cced91e
7
+ data.tar.gz: efc042caa238b8f37c6420255b56ea6715401cdfa422e84f4aa9cc3e9e401711ea89d45eb20cac9579026ad95e7a81e600129411157f7bcca8640e6c73551199
data/README.md CHANGED
@@ -1,5 +1,119 @@
1
- # octicons
1
+ # Octicons gem
2
2
 
3
3
  [![Gem version](https://img.shields.io/gem/v/octicons.svg)](https://rubygems.org/gems/octicons)
4
+ [![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
4
5
 
5
- See https://primer.style/octicons/packages/ruby
6
+ > Octicons gem to distribute octicons svg
7
+
8
+ ## Install
9
+
10
+ Add this to your `Gemfile`
11
+
12
+ ```rb
13
+ gem 'octicons'
14
+ ```
15
+
16
+ Then `bundle install`.
17
+
18
+ ## Usage
19
+
20
+ ```rb
21
+ require 'octicons'
22
+ icon = Octicons::Octicon.new("x")
23
+ icon.to_svg
24
+ # <svg class="octicon octicon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
25
+ ```
26
+
27
+ ## Documentation
28
+
29
+ The `Octicon` class takes two arguments. The first is the symbol of the icon, and the second is a hash of arguments representing html attributes
30
+
31
+ #### `symbol` _(required)_
32
+
33
+ This is the name of the octicon you want to use. For example `alert`. [Full list of icons][octicons-docs]
34
+
35
+ #### Options
36
+
37
+ * `:height` - When setting the height to a number, the icon will scale to that size. For example, passing `32`, will calculate the width based on the icon's natural size.
38
+ * `:width` - When setting the width to a number, the icon will scale to that size. For example, passing `32`, will calculate the width based on the icon's natural size.
39
+
40
+ If both `:width, :height` are passed into the options hash, then the icon will be sized exactly at those dimensions.
41
+
42
+ #### Attributes
43
+
44
+ Once initialized, you can read a few properties from the icon.
45
+
46
+ ##### `symbol`
47
+
48
+ Returns the string of the symbol name
49
+
50
+ ```rb
51
+ icon = Octicons::Octicon.new("x")
52
+ icon.symbol
53
+ # "x"
54
+ ```
55
+
56
+ ##### `path`
57
+
58
+ Path returns the string representation of the path of the icon.
59
+
60
+ ```rb
61
+ icon = Octicons::Octicon.new("x")
62
+ icon.path
63
+ # <path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path>
64
+ ```
65
+
66
+ ##### `options`
67
+
68
+ This is a hash of all the `options` that will be added to the output tag.
69
+
70
+ ```rb
71
+ icon = Octicons::Octicon.new("x")
72
+ icon.options
73
+ # {:class=>"octicon octicon-x", :viewBox=>"0 0 12 16", :version=>"1.1", :width=>12, :height=>16, :"aria-hidden"=>"true"}
74
+ ```
75
+
76
+ ##### `width`
77
+
78
+ Width is the icon's true width. Based on the svg view box width. _Note, this doesn't change if you scale it up with size options, it only is the natural width of the icon_
79
+
80
+ ##### `height`
81
+
82
+ Height is the icon's true height. Based on the svg view box height. _Note, this doesn't change if you scale it up with size options, it only is the natural height of the icon_
83
+
84
+ ##### `keywords`
85
+
86
+ Returns an array of keywords for the icon. The data comes from the [data file in lib](../data.json). Consider contributing more aliases for the icons.
87
+
88
+ ```rb
89
+ icon = Octicons::Octicon.new("x")
90
+ icon.keywords
91
+ # ["remove", "close", "delete"]
92
+ ```
93
+
94
+ #### Methods
95
+
96
+ ##### `to_svg`
97
+
98
+ Returns a string of the svg tag
99
+
100
+ ```rb
101
+ icon = Octicons::Octicon.new("x")
102
+ icon.to_svg
103
+ # <svg class="octicon octicon-x" viewBox="0 0 16 16" width="16" height="16" version="1.1" "aria-hidden"="true"><path d="M7.48 8l3.75 3.75-1.48 1.48L6 9.48l-3.75 3.75-1.48-1.48L4.52 8 .77 4.25l1.48-1.48L6 6.52l3.75-3.75 1.48 1.48z"></path></svg>
104
+ ```
105
+
106
+ ## Documentation
107
+
108
+ For a full list of options available, see the [octicons_gem documentation](../octicons_gem/#documentation)
109
+
110
+ ## License
111
+
112
+ (c) GitHub, Inc.
113
+
114
+ When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
115
+
116
+ [MIT](./LICENSE)
117
+
118
+ [octicons]: https://github.com/primer/octicons
119
+ [octicons-docs]: https://octicons.github.com/