Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abeidahmed committed Dec 21, 2023
1 parent 9a669a5 commit 9db2bba
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ need to set the `size` attribute on the helper method.
<%= heroicon "user", size: 20 %>
```

If the `variant` is set as `outline` or `solid`, `size` automatically defaults to `24`,
if the `variant` is set as `mini`, `size` automatically defaults to `20`, and if the `variant`
is set as `micro`, `size` automatically defaults to `16`. However, this can be over-written with
If the `variant` is set as `outline` or `solid`, `size` defaults to `24`,
if the `variant` is set as `mini`, `size` defaults to `20`, and if the `variant`
is set as `micro`, `size` defaults to `16`. However, this can be over-written with
the `size` attribute.

### Accessibility
Expand Down
7 changes: 4 additions & 3 deletions lib/rails_heroicon/helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ module Helper
# The helper method accepts mutiple arguments such as:
#
# === Variant
# There are three types of variants: 'outline', 'solid' and 'mini', the default being the 'outline'.
# There are 4 types of variants: 'outline', 'solid', 'mini', and 'micro', the default being the 'outline'.
# To specify the solid variant, call <tt><%= heroicon "icon_name", variant: "solid" %></tt>
#
# === HTML attributes
Expand All @@ -28,8 +28,9 @@ module Helper
#
# This will set the <tt>height</tt> and <tt>width</tt> attribute on the svg.
#
# If the variant is set as <tt>outline</tt> or <tt>solid</tt>, size automatically defaults to 24,
# and if the variant is set as <tt>mini</tt>, size automatically defaults to 20.
# If the variant is set as <tt>outline</tt> or <tt>solid</tt>, <tt>size</tt> defaults to 24, if the variant is set
# as <tt>mini</tt>, <tt>size</tt> defaults to 20, and if the variant is set as <tt>micro<tt>, <tt>size</tt>
# defaults to 16.
# However, this can be over-written with the <tt>size</tt> attribute.
#
# == Accessibility
Expand Down

0 comments on commit 9db2bba

Please sign in to comment.