forticons 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e159cff63ce281a56e5e58378055e2d77f04d979730a1a23ffc00d1f22286742
+  data.tar.gz: a763e20d4054018051e33f7745a2611822794510c3b19ca01e6d44842785a273
+SHA512:
+  metadata.gz: 3ec5c886da3644f7171d7d3cb7150049d553dce42ea5a7417ca72f12ddb6b4037978d3c8a966a172f449555bd88b559cb5a998141cf98320f8f7a03761fd88c5
+  data.tar.gz: 97a88864517cabe8bb5b9d3f06a9d33bf1a7a2050e766f02a1c9cd4775d5883df0950ededad9e7efcad5551b033d66391c3b6a636fd28382b26530ee397abf7d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# forticons 
+
+[![Gem version](https://img.shields.io/gem/v/forticons.svg)](https://rubygems.org/gems/forticons)
+
+## Install
+
+Add this to your `Gemfile`
+
+```rb
+gem 'forticons'
+```
+
+Then `bundle install`.
+
+If using a framework like Rails, please follow the [installation instructions](https://primer.style/view-components/#installation) in the [Primer ViewComponents](https://primer.style/view-components) documentation. 
+
+## Usage
+
+```rb
+require 'forticons'
+icon = Forticons::Forticon.new("x")
+icon.to_svg
+# <svg class="forticon forticon-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>
+```
+
+## Documentation
+
+The `Forticon` class takes two arguments. The first is the symbol of the icon, and the second is a hash of arguments representing html attributes
+
+### `symbol` _(required)_
+
+This is the name of the forticon you want to use. For example `alert`. [Full list of icons](/)
+
+### Options
+
+* `: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.
+* `: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.
+
+If both `:width, :height` are passed into the options hash, then the icon will be sized exactly at those dimensions.
+
+### Attributes
+
+Once initialized, you can read a few properties from the icon.
+
+#### `symbol`
+
+Returns the string of the symbol name
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.symbol
+# "x"
+```
+
+#### `path`
+
+Path returns the string representation of the path of the icon.
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.path
+# <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>
+```
+
+#### `options`
+
+This is a hash of all the `options` that will be added to the output tag.
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.options
+# {:class=>"forticon forticon-x", :viewBox=>"0 0 12 16", :version=>"1.1", :width=>12, :height=>16, :"aria-hidden"=>"true"}
+```
+
+#### `width`
+
+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_
+
+#### `height`
+
+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_
+
+#### `keywords`
+
+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.
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.keywords
+# ["remove", "close", "delete"]
+```
+
+### Methods
+
+#### `to_svg`
+
+Returns a string of the svg tag
+
+```rb
+icon = Forticons::Forticon.new("x")
+icon.to_svg
+# <svg class="forticon forticon-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>
+```