faicons

0.2.2 · active · verified Wed Apr 15

faicons is a Python library that provides an interface to Font-Awesome for use in Shiny for Python applications. It enables developers to easily embed scalable vector graphic (SVG) icons from Font Awesome 6.2.0 into their Shiny UI. The current version is 0.2.2, with releases occurring infrequently, typically for minor improvements or Font Awesome version updates.

Warnings

gotcha The library is currently listed with a '2 - Pre-Alpha' development status on PyPI, indicating it is still in early development and APIs might be subject to change.
Fix: Be aware that the API may not be fully stable. Review release notes for any breaking changes in future versions.
gotcha The `icon_svg()` function's `height` and `width` parameters expect a numerical value followed by a CSS length unit (e.g., '100px', '2em'), not a percentage value like '100%'. Providing a percentage will raise a `ValueError`.
Fix: Use explicit CSS length units (e.g., `icon_svg("icon-name", height="2em")`) or manage sizing via parent CSS rules.
gotcha faicons currently uses Font Awesome 6.2.0. Font Awesome 7.0 introduced significant breaking changes (e.g., fixed-width icons by default, changes to SVG path classes, removal of legacy webfonts). Icons and styling expectations from FA7 might not apply or work as expected with faicons.
Fix: Refer to the Font Awesome 6.2.0 documentation for available icons and their exact names. Be aware that newer FA7 features or icons might not be present or compatible. Consider external CSS for FA7 compatibility if needed.
gotcha While faicons provides a Python interface for Font Awesome icons, it is specifically designed 'for use in Shiny for Python'. Directly generating standalone SVG strings with `icon_svg()` outside of a framework that renders HTML (like Shiny) may require additional handling to display them correctly in a web context.
Fix: Ensure `faicons` is used within a compatible web framework like Shiny for proper rendering. If used independently, embed the output of `icon_svg()` into HTML content that supports SVG rendering.

Install

pip install faicons Install faicons

Imports

icon_svg
```
from faicons import icon_svg
```

Quickstart

This example demonstrates how to integrate `faicons.icon_svg` into a basic Shiny for Python application to add Font Awesome icons to UI elements like action buttons.

from shiny import App, ui
from faicons import icon_svg

app_ui = ui.page_fluid(
    ui.h2("Shiny App with faicons"),
    ui.input_action_button("like_button", "Like", icon=icon_svg("thumbs-up")),
    ui.input_action_button("share_button", "Share", icon=icon_svg("share-alt")),
    ui.output_text("feedback"),
)

def server(input, output, session):
    @ui.reactive.Effect
    @ui.event(input.like_button)
    def _():
        ui.notification_show("You liked it!")

    @ui.reactive.Effect
    @ui.event(input.share_button)
    def _():
        ui.notification_show("You shared it!")

app = App(app_ui, server)

view raw JSON →