djc-phosphor-icons

Installation

pip install djc-phosphor-icons

Add to INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    "django_components",
    "djc_phosphor_icons",
]

Usage

{% component "Icon" name="house" / %}
{% component "Icon" name="house" weight="bold" / %}
{% component "Icon" name="house" style="stroke" size=24 color="#ff0000" / %}

Kwarg	Type	Default	Description
`name`	`str`	—	Icon name, e.g. `"house"`
`weight`	`str`	`"regular"`	`bold`, `duotone`, `fill`, `light`, `regular`, `thin`
`style`	`str`	`"flat"`	`flat` or `stroke`
`size`	`int`	`None`	Sets width and height in px
`color`	`str`	`None`	Sets CSS `color`
`mirrored`	`bool`	`False`	Flips the icon horizontally
`attrs`	`dict`	`None`	Extra attributes passed to the `<svg>` element

Settings

Configure via PHOSPHOR_ICONS in your Django settings:

PHOSPHOR_ICONS = {
    "auto_register": True,        # Auto-register the component on startup (default: True)
    "component_name": "Icon",     # Template tag name (default: "Icon")
    "default_style": "flat",      # Default style (default: "flat")
    "default_weight": "regular",   # Default weight (default: "regular")
    "cache": True,                # Cache rendered output per unique set of kwargs (default: True)
}

Development

uv sync
uv run pytest
uv run ruff check .
uv run ruff format .

To update the icon set to a specific Phosphor release (for local inspection only — the update-icons GitHub Action handles this automatically when committing):

uv run python scripts/download_icons.py v2.1.0

To generate a visual preview of all icons:

uv run python scripts/preview_icons.py

Known Icon Issues

The following icons are incomplete in the upstream Phosphor release and will fail to render in certain combinations:

book-user: missing from stroke/light, stroke/bold, stroke/fill, stroke/duotone

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djc_phosphor_icons-0.1.0.tar.gz (3.7 MB view details)

Uploaded Aug 5, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

djc_phosphor_icons-0.1.0-py3-none-any.whl (9.1 MB view details)

Uploaded Aug 5, 2026 Python 3

File details

Details for the file djc_phosphor_icons-0.1.0.tar.gz.

File metadata

Download URL: djc_phosphor_icons-0.1.0.tar.gz
Upload date: Aug 5, 2026
Size: 3.7 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for djc_phosphor_icons-0.1.0.tar.gz
Algorithm	Hash digest
SHA256	`22c664203cfa49105079ce20040bf8b09352418fd33a0cd94a5e95cad037d5a6`
MD5	`c437a6d1c6cfeccf4548d8d1ee876b96`
BLAKE2b-256	`3334aacd3107323674792f6d5553bf737f0c8f84f0a6e56b2e7af2a4737983b4`

See more details on using hashes here.

Provenance

The following attestation bundles were made for djc_phosphor_icons-0.1.0.tar.gz:

Publisher: publish.yml on joeyjurjens/djc-phosphor-icons

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: djc_phosphor_icons-0.1.0.tar.gz
- Subject digest: 22c664203cfa49105079ce20040bf8b09352418fd33a0cd94a5e95cad037d5a6
- Sigstore transparency entry: 2343783307
- Sigstore integration time: Aug 5, 2026
Source repository:
- Permalink: joeyjurjens/djc-phosphor-icons@a42a71024d5bc60ef0ca4d1adcbe1c4c884665be
- Branch / Tag: refs/tags/v0.1.0
- Owner: https://github.com/joeyjurjens
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@a42a71024d5bc60ef0ca4d1adcbe1c4c884665be
- Trigger Event: release