Phoenix Iconify

https://hexdocs.pm/phoenix_iconify/0.1.0
Admin
Phoenix components for Iconify icons with compile-time discovery, enabling access to 200,000+ icons...
Tokens:3,786
Snippets:101
Trust Score:9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Show Help

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.md

Displays the help message for the `mix phoenix_iconify` tasks. Use this to get an overview of available commands.

```elixir
mix phoenix_iconify
```

--------------------------------

### get_icons

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Gets icons from the manifest, loading from the compiled module attribute if available.

```APIDOC
## get_icons

### Description
Gets icons from the manifest, loading from the compiled module attribute if available.

### Function Signature
get_icons()
```

--------------------------------

### List All Icons

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.List.md

Run this command to display all icons available in the manifest.

```bash
mix phoenix_iconify.list
```

--------------------------------

### write

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Writes the manifest to disk.

```APIDOC
## write

### Description
Writes the manifest to disk.

### Function Signature
write()
```

--------------------------------

### read

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Reads the manifest from disk.

```APIDOC
## read

### Description
Reads the manifest from disk.

### Function Signature
read()
```

--------------------------------

### Fetch All Manifest Icons

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.Cache.md

Fetches all icon sets specified in your manifest. This pre-fetches icons to speed up future compilations.

```bash
mix phoenix_iconify.cache fetch
```

--------------------------------

### Configure Extra Icons and Fallback

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/readme.md

Configure additional icons for dynamic usage and specify a fallback icon in config/config.exs.

```elixir
config :phoenix_iconify,
  extra_icons: ["heroicons:check", "heroicons:x-mark"],
  
  fallback: "heroicons:question-mark-circle",
  
  warn_on_missing: true
```

--------------------------------

### Enable Runtime Icon Fetching (Development Only)

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Enable runtime fetching for dynamic icons during development. This option requires the :req library and should not be used in production.

```elixir
config :phoenix_iconify,
  runtime_fetch: true  # Only for dev!
```

--------------------------------

### Fetch Specific Icon Sets

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.Cache.md

Fetches specific icon sets by their prefixes, such as 'heroicons' or 'lucide'. This is useful for pre-fetching only the icons you need.

```bash
mix phoenix_iconify.cache fetch heroicons lucide
```

--------------------------------

### manifest_path

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Returns the path to the manifest file for the given application.

```APIDOC
## manifest_path

### Description
Returns the path to the manifest file for the given application.

### Function Signature
manifest_path(app)
```

--------------------------------

### count

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Returns the number of icons in the manifest.

```APIDOC
## count

### Description
Returns the number of icons in the manifest.

### Function Signature
count()
```

--------------------------------

### List Icons by Prefix

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.List.md

Use the `--prefix` option to filter the list and show only icons belonging to a specific prefix, such as 'heroicons'.

```bash
mix phoenix_iconify.list --prefix heroicons
```

--------------------------------

### Add PhoenixIconify Compiler to mix.exs

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.Compile.PhoenixIconify.md

Include `:phoenix_iconify` in the `compilers` list in your `mix.exs` file to enable the automatic compilation of icon assets.

```elixir
def project do
  [
    compilers: Mix.compilers() ++ [:phoenix_iconify],
    # ...
  ]
end
```

--------------------------------

### Show Icon and Cache Statistics

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.md

Displays statistics related to icons and the cache. This command is useful for monitoring and understanding resource usage.

```elixir
mix phoenix_iconify.stats
```

--------------------------------

### Use Phoenix Heroicon Format

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

PhoenixIconify supports Phoenix's shorthand 'hero-*' format for icon names, providing compatibility with existing icon references.

```heex
<.icon name="hero-user" />
<.icon name="hero-user-solid" />
```

--------------------------------

### Pre-register Dynamic Icons

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

For dynamic icon names, pre-register them in your application's configuration to ensure they are available.

```elixir
config :phoenix_iconify,
  extra_icons: ["heroicons:check", "heroicons:x-mark"]
```

--------------------------------

### Configure PhoenixIconify Runtime Fetching

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Enable or disable runtime fetching of icons. This is intended for development environments only and requires the :req library.

```elixir
config :phoenix_iconify,
  runtime_fetch: false
```

--------------------------------

### Cache Management

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.md

Provides commands for managing the icon cache. This is essential for ensuring the cache is up-to-date and efficient.

```elixir
mix phoenix_iconify.cache
```

--------------------------------

### Add PhoenixIconify Dependency

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/readme.md

Add the phoenix_iconify library to your project's dependencies in the mix.exs file.

```elixir
def deps do
  [
    {:phoenix_iconify, "~> 0.1.0"}
  ]
end
```

--------------------------------

### List Cached Icon Sets

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.Cache.md

Lists the icon sets currently stored in the local cache.

```bash
mix phoenix_iconify.cache list
```

--------------------------------

### load_set

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Loads an icon set directly from the local cache.

```APIDOC
## `load_set`

### Description
Loads a cached icon set.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### fetch_set

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Fetches an icon set, prioritizing the local cache if the set is available.

```APIDOC
## `fetch_set`

### Description
Fetches an icon set, using cache if available.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### Import Icon Component

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/readme.md

Import the 'icon' function from PhoenixIconify in your web module's html_helpers.

```elixir
defp html_helpers do
  quote do
    import PhoenixIconify, only: [icon: 1]
    # ...
  end
end
```

--------------------------------

### Configure PhoenixIconify Missing Icon Warnings

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Enable or disable warnings when icons are not found in the manifest. This can be useful for debugging missing icons.

```elixir
config :phoenix_iconify,
  warn_on_missing: true
```

--------------------------------

### Configure Extra Icons for Dynamic Usage

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/readme.md

Register icons that cannot be discovered at compile time, such as those from a database, by listing them in extra_icons.

```elixir
config :phoenix_iconify,
  extra_icons: [
    "heroicons:check",
    "heroicons:x-mark",
    "heroicons:exclamation-triangle"
  ]
```

--------------------------------

### stats

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Returns statistics about the current state of the icon set cache.

```APIDOC
## `stats`

### Description
Returns cache statistics.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### Configure PhoenixIconify Extra Icons

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Specify additional icons to be included in the manifest, particularly useful for dynamic icon usage. This is an empty list by default.

```elixir
config :phoenix_iconify,
  extra_icons: []
```

--------------------------------

### Use Icons in Templates

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/readme.md

Render icons in your HEEx templates using the <.icon /> component with the 'name' attribute.

```heex
<.icon name="heroicons:user" />
<.icon name="heroicons:user" class="w-6 h-6 text-blue-500" />
<.icon name="lucide:home" id="home-icon" />
```

--------------------------------

### clear

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Clears all cached icon sets from the local cache.

```APIDOC
## `clear`

### Description
Clears all cached icon sets.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### Configure PhoenixIconify Fallback Icon

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Set a fallback icon to be displayed when a requested icon is not found. This configuration option helps maintain UI consistency.

```elixir
config :phoenix_iconify,
  fallback: "heroicons:question-mark-circle"
```

--------------------------------

### Use Icons in Heex Templates

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Render icons in your Heex templates using the <.icon /> component, specifying the icon name and optional CSS classes.

```heex
<.icon name="heroicons:user" class="w-5 h-5" />
<.icon name="lucide:home" />
```

--------------------------------

### add_icon

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Adds an icon to the runtime cache and optionally persists it to disk. This is used for runtime-fetched icons in development.

```APIDOC
## add_icon

### Description
Adds an icon to the runtime cache and optionally persists it to disk. This is used for runtime-fetched icons in development.

### Function Signature
add_icon(icon_name, icon_data)
```

--------------------------------

### reload

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Reloads icons from disk into persistent_term.

```APIDOC
## reload

### Description
Reloads icons from disk into persistent_term.

### Function Signature
reload()
```

--------------------------------

### cache_dir

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Returns the path to the directory where icon sets are cached locally.

```APIDOC
## `cache_dir`

### Description
Returns the cache directory path.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### save_set

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Saves a given icon set to the local cache.

```APIDOC
## `save_set`

### Description
Saves an icon set to cache.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### set_path

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Returns the specific file path for a cached icon set within the cache directory.

```APIDOC
## `set_path`

### Description
Returns the path for a cached icon set.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### get_icon

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Retrieves a specific icon from the cache. If the icon set is not cached, it will be fetched.

```APIDOC
## `get_icon`

### Description
Gets a specific icon from cache, fetching the set if needed.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### Clear Icon Cache

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/Mix.Tasks.PhoenixIconify.Cache.md

Removes all cached icon sets from the local storage. Use this if you need to refresh the cache or free up space.

```bash
mix phoenix_iconify.cache clear
```

--------------------------------

### Render Icon with CSS Classes

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Apply custom CSS classes to the rendered SVG icon for styling purposes.

```heex
<.icon name="heroicons:user" class="w-6 h-6 text-blue-500" />
```

--------------------------------

### clear_cache

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Manifest.md

Clears the cached icons.

```APIDOC
## clear_cache

### Description
Clears the cached icons.

### Function Signature
clear_cache()
```

--------------------------------

### list_cached_sets

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Returns a list of all icon set prefixes that are currently stored in the local cache.

```APIDOC
## `list_cached_sets`

### Description
Lists all cached icon set prefixes.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### has_set?

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.Cache.md

Checks whether a given icon set is currently stored in the local cache.

```APIDOC
## `has_set?`

### Description
Checks if an icon set is cached locally.

### Method
N/A (Function call)

### Endpoint
N/A
```

--------------------------------

### Render Icon with Custom ID

Source: https://hexdocs.pm/phoenix_iconify/0.1.0/PhoenixIconify.md

Assign a specific ID attribute to the rendered SVG icon, useful for JavaScript interactions or specific CSS targeting.

```heex
<.icon name="lucide:home" id="home-icon" />
```
Tokens:
Raw