octicons 0.0.0.pre.7c22536 → 0.0.0.pre.7cf3ed8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +2 -116
  4. data/lib/build/data.json +1 -1
  5. data/lib/build/svg/alert.svg +1 -1
  6. data/lib/build/svg/archive.svg +1 -1
  7. data/lib/build/svg/beaker.svg +1 -1
  8. data/lib/build/svg/broadcast.svg +1 -1
  9. data/lib/build/svg/checklist.svg +1 -1
  10. data/lib/build/svg/circle-slash.svg +1 -1
  11. data/lib/build/svg/clock.svg +1 -1
  12. data/lib/build/svg/dashboard.svg +1 -1
  13. data/lib/build/svg/dependent.svg +1 -0
  14. data/lib/build/svg/eye-closed.svg +1 -1
  15. data/lib/build/svg/file-pdf.svg +1 -1
  16. data/lib/build/svg/file-zip.svg +1 -1
  17. data/lib/build/svg/git-branch.svg +1 -1
  18. data/lib/build/svg/git-compare.svg +1 -1
  19. data/lib/build/svg/git-merge.svg +1 -1
  20. data/lib/build/svg/git-pull-request.svg +1 -1
  21. data/lib/build/svg/github-action.svg +1 -1
  22. data/lib/build/svg/heart-outline.svg +1 -0
  23. data/lib/build/svg/heart.svg +1 -1
  24. data/lib/build/svg/history.svg +1 -1
  25. data/lib/build/svg/infinity.svg +1 -0
  26. data/lib/build/svg/info.svg +1 -1
  27. data/lib/build/svg/internal-repo.svg +3 -0
  28. data/lib/build/svg/issue-closed.svg +1 -1
  29. data/lib/build/svg/issue-opened.svg +1 -1
  30. data/lib/build/svg/issue-reopened.svg +1 -1
  31. data/lib/build/svg/kebab-horizontal.svg +1 -1
  32. data/lib/build/svg/kebab-vertical.svg +1 -1
  33. data/lib/build/svg/line-arrow-down.svg +1 -0
  34. data/lib/build/svg/line-arrow-left.svg +1 -0
  35. data/lib/build/svg/line-arrow-right.svg +1 -0
  36. data/lib/build/svg/line-arrow-up.svg +1 -0
  37. data/lib/build/svg/logo-github.svg +1 -1
  38. data/lib/build/svg/mark-github.svg +1 -1
  39. data/lib/build/svg/mortar-board.svg +1 -1
  40. data/lib/build/svg/north-star.svg +3 -0
  41. data/lib/build/svg/package.svg +1 -1
  42. data/lib/build/svg/pencil.svg +1 -1
  43. data/lib/build/svg/person.svg +1 -1
  44. data/lib/build/svg/pin.svg +1 -1
  45. data/lib/build/svg/play.svg +1 -1
  46. data/lib/build/svg/primitive-dot-stroke.svg +1 -0
  47. data/lib/build/svg/project.svg +1 -1
  48. data/lib/build/svg/question.svg +1 -1
  49. data/lib/build/svg/radio-tower.svg +1 -1
  50. data/lib/build/svg/repo-forked.svg +1 -1
  51. data/lib/build/svg/repo-template-private.svg +1 -0
  52. data/lib/build/svg/repo-template.svg +1 -0
  53. data/lib/build/svg/report.svg +1 -1
  54. data/lib/build/svg/request-changes.svg +1 -1
  55. data/lib/build/svg/rocket.svg +1 -1
  56. data/lib/build/svg/rss.svg +1 -1
  57. data/lib/build/svg/saved.svg +1 -0
  58. data/lib/build/svg/search.svg +1 -1
  59. data/lib/build/svg/shield-check.svg +1 -0
  60. data/lib/build/svg/shield-lock.svg +1 -0
  61. data/lib/build/svg/shield-x.svg +1 -0
  62. data/lib/build/svg/shield.svg +1 -1
  63. data/lib/build/svg/skip.svg +1 -0
  64. data/lib/build/svg/smiley.svg +1 -1
  65. data/lib/build/svg/sync.svg +1 -1
  66. data/lib/build/svg/tag.svg +1 -1
  67. data/lib/build/svg/telescope.svg +1 -1
  68. data/lib/build/svg/unmute.svg +1 -1
  69. data/lib/build/svg/unsaved.svg +1 -0
  70. data/lib/build/svg/unverified.svg +1 -1
  71. data/lib/build/svg/verified.svg +1 -1
  72. data/lib/build/svg/workflow-all.svg +1 -0
  73. data/lib/build/svg/workflow.svg +1 -0
  74. data/lib/octicons/octicon.rb +2 -2
  75. data/lib/octicons/version.rb +1 -1
  76. metadata +22 -3
  77. data/lib/build/svg/frowny.svg +0 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 03ba869dff1f679bb7886bca90366e0831945cfac989e07347b898b308359b24
4
- data.tar.gz: c2268c624ef1ec123d71c474fe9f68bdac20cfefd6b8be04a7c7dbf1e7751276
3
+ metadata.gz: 57b790e057945f691735d638f1b1a2d0258c09ab9a18e03233df368acc7c7db0
4
+ data.tar.gz: e111670513c10c92b7effce0a917840abf3a01685e03f05145c42e3b2dfdb9f1
5
5
  SHA512:
6
- metadata.gz: 54f7e7c4c17a5c47f7dba3a68a517bf4102881f9e201b594eea986ab1efe539666030672fedb74f78c3f0a70726372ba36f34cd8ba664e0bbc01dbfa63eb1b5e
7
- data.tar.gz: 9a80d22dcc7f8bdd42dc840ea4f6e2496240866344daa9e674adee60153b79e0036185c172127d86cfdaa327fbc2c9e803cdc22edf8ac52af3b386c076611e4e
6
+ metadata.gz: ea0ea3b8c6f8c24781979ad0f1e50988237e056216b511c5a7cbeb2ca6166292d5cf7333d6c28fd5f6d0318b058c5a5134eb4e78d5fe42e09490beb99943b132
7
+ data.tar.gz: 5ecf12057ca3048e49ec6b2e76acf4d69a3195dae008e4e0f3145abcf86f17ed612e1008e451ca5130de395d8806a821896c9e0c9679942ecfbd11cf822ab412
data/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2019 GitHub Inc.
3
+ Copyright (c) 2020 GitHub Inc.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
data/README.md CHANGED
@@ -1,119 +1,5 @@
1
- # Octicons gem
1
+ # octicons
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)
5
4
 
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/
5
+ See https://primer.style/octicons/packages/ruby