Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PLAY-1618] Font Awesome Setup Documentation - Phase 1 #3865

Merged
merged 14 commits into from
Nov 1, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: Font Awesome Setup
description: Playbook seamlessly integrates with Font Awesome, a leading icon library known for its extensive collection of high-quality, scalable icons. This integration not only enhances the visual appeal of websites and applications but also improves overall usability.
icon: font-awesome
---

Playbook seamlessly integrates with [Font Awesome](https://fontawesome.com/), a leading icon library known for its extensive collection of high-quality, scalable icons. This integration not only enhances the visual appeal of websites and applications but also improves overall usability.

Some Font Awesome benefits:

**1. Wide Range of Icons:** Font Awesome offers a vast selection of icons to suit a variety of needs. You can easily find the perfect icon for your project through their [icon search](https://fontawesome.com/search).
**2. Ease of Use:** The icons are straightforward to implement. With just a few lines of code, you can quickly and easily add visual elements to your web projects. Note, a Pro subscription is required for access to a wider range of icons beyond the [Free set](https://fontawesome.com/search?o=r&m=free&s=regular).
**3. Visual Appeal:** Incorporating these icons can improve the aesthetic of your site or application, making it more attractive to users. With Playbook, you have the flexibility to customize color, size, and animations.
**4. User-Friendliness:** Icons can help users navigate and understand your website or application more efficiently, enhancing their overall experience. Font Awesome icons are web fonts compatible with most browsers and are optimized for performance and accessibility.

Integrating Font Awesome with Playbook ensures that you have access to these benefits, making your projects more polished and professional.

![fontawesome](https://github.com/user-attachments/assets/638b63ad-56d3-4819-8e05-fcbb175bedc7)

## Ruby on Rails Setup (default with asset pipeline)

**Make sure you are on Rails 7 or higher.**

**1.** Follow the [Ruby on Rails Setup getting started page](/guides/getting_started/ruby_on_rails_setup) to setup Playbook with your Rails project.

**2.** Setup Pro or Free Font Awesome to use our Icon Component.

**Pro:**

```rb
# app/assets/stylesheets/application.scss
@import "font-awesome-pro";
@import "font-awesome-pro/solid";
@import "font-awesome-pro/regular";
@import "playbook";
```

```rb
# app/Gemfile
source "https://token:[email protected]/basic/fontawesome-pro/ruby/" do
gem "font-awesome-pro-sass", "6.2.0"
end
```

**Free:**

*Currently only [Free Regular](https://fontawesome.com/search?o=r&m=free&s=regular) icons are supported in our icon component structure.*

```rb
# app/assets/stylesheets/application.scss
@import "font-awesome";
```

```rb
# app/Gemfile
source "https://token:[email protected]/basic/fontawesome-pro/ruby/" do
gem "font-awesome-pro-sass", "6.2.0"
end
```

**3.** Bundle all the things!

```sh
bundle install
```

**4.** **Go build awesome stuff!**

Refer to our [Icon kit](/kits/icon) to get started with Font Awesome icons in Playbook.

```rb
<%= pb_rails("icon", props: { icon: "font-awesome", fixed_width: true }) %>
```
4 changes: 2 additions & 2 deletions playbook-website/config/initializers/global_variables.rb
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@

# Move HTML figma to the end

move_pages = navigation[:getting_started][:pages].select { |page| ["HTML&_CSS", "figma_setup", "how_to_theme"].include?(page[:page_id]) }
navigation[:getting_started][:pages].reject! { |page| ["HTML&_CSS", "figma_setup", "how_to_theme"].include?(page[:page_id]) }
move_pages = navigation[:getting_started][:pages].select { |page| ["HTML&_CSS", "figma_setup", "how_to_theme", "font_awesome"].include?(page[:page_id]) }
navigation[:getting_started][:pages].reject! { |page| ["HTML&_CSS", "figma_setup", "how_to_theme", "font_awesome"].include?(page[:page_id]) }
navigation[:getting_started][:pages].concat(move_pages)

DOCS = navigation
Loading