Skip to main content

OutfitKit Jinja macros — semantic HTML components on top of the OutfitKit CSS library.

Project description

OutfitKit

Librería CSS de componentes para aplicaciones web. API composable sin clases combinadas: componente + variante + tamaño + estilo.

Cero JS obligatorio. Cero build pipeline para consumidores. Un solo <link> y listo.

Uso (consumidor solo CSS)

Producción (default, sin prefijo)

<link rel="stylesheet"
      href="https://cdn.jsdelivr.net/gh/OutfitKit/outfitkit@latest/css/outfitkit.css">

<button class="btn primary lg">Continuar</button>
<button class="btn outline danger sm">Borrar</button>

Clases cortas, sin ruido. La API esperada es composable: [componente] × [variante] × [tamaño] × [estilo].

Compatibilidad legacy (ok-)

Solo relevante para consumers antiguos congelados en la API prefijada. La librería actual y las macros públicas trabajan sin prefijo; dist/outfitkit.ok.min.css se conserva como snapshot de compatibilidad para integraciones v1.5 que todavía no han migrado.

<link rel="stylesheet"
      href="https://cdn.jsdelivr.net/gh/OutfitKit/outfitkit@latest/dist/outfitkit.ok.min.css">

<button class="ok-btn ok-primary ok-lg">Continuar</button>

Si empiezas hoy, usa siempre el bundle canónico sin prefijo.

Desarrollo — fuente sin minificar

Útil para inspeccionar reglas individuales en DevTools:

<link rel="stylesheet"
      href="https://cdn.jsdelivr.net/gh/OutfitKit/outfitkit@main/css/outfitkit.css">

<button class="btn primary">Continuar</button>

La fuente en css/ ya es la API canónica. Los navegadores modernos resuelven los @import directamente, sin bundling local.

Macros Jinja (opcional)

Si tu backend es Python con Jinja2 (FastAPI, Flask, Django+jinja2 backend), puedes consumir los componentes como macros:

pip install outfitkit             # macros vanilla
pip install outfitkit[jinjax]     # + sintaxis HTML-like <Button label="x" />

Las macros viven en showcase/ y se publican desde ahí a PyPI. Cualquier macro funciona con o sin JinjaX (formato dual-mode).

Setup mínimo

from jinja2 import Environment, FileSystemLoader
from outfitkit import TEMPLATES_DIR, register_globals, css_url

env = Environment(loader=FileSystemLoader(TEMPLATES_DIR))
register_globals(env)            # no-op compatible

# En tu base.html
#   <link rel="stylesheet" href="{{ css }}">
ctx = {"css": css_url()}         # → outfitkit.min.css (sin prefijo)

Resultado: {{ button("Save") }}<button class="btn primary">…</button>.

Regla de oro

Las macros públicas de OutfitKit 2.x emiten clases canónicas sin prefijo. Si todavía dependes de ok-, te quedas en la rama/tag legacy compatible y cargas su bundle correspondiente por tu cuenta.

¿El paquete pip install outfitkit trae el CSS?

No, y es intencional. El paquete pip trae solo:

  • Las macros Jinja (outfitkit/templates/ui/*.jinja) que se importan en tu app.
  • Helpers Python (TEMPLATES_DIR, register_globals, css_url, theme_url) que devuelven rutas y URLs.

El CSS lo sirve jsDelivr (CDN externo, gratis, edge-cached globalmente). El helper css_url() te devuelve la URL ya construida — tu plantilla solo tiene que ponerla en un <link>:

<link rel="stylesheet" href="{{ css_url() }}">

Por qué separados:

  1. Versionado independiente: un fix de CSS no necesita bumpear PyPI. Solo retaggeas vX.Y.Z y jsDelivr sirve la nueva versión al instante.
  2. Sin tráfico duplicado: no servirías 540 KB de CSS desde tu propio backend en cada petición; jsDelivr lo hace gratis y con CDN global.
  3. Wheels Python no son ideales para assets estáticos: empaquetar el CSS dentro obligaría a pip install --upgrade cada vez que cambia.

¿Y si necesito servir el CSS desde mi propio backend? (offline / aislado)

Casos válidos: red privada sin internet, paranoia con CDN, o cumplimiento que prohíbe externos. Tres opciones:

Opción A — descargar el bundle a tu static/:

# Una vez, en tu deploy script:
curl -L -o static/css/outfitkit.min.css \
  https://cdn.jsdelivr.net/gh/OutfitKit/outfitkit@v1.3.0/dist/outfitkit.min.css

Y sirvelo desde tu backend:

<link rel="stylesheet" href="/static/css/outfitkit.min.css">

Opción B — git submodule del repo CSS:

git submodule add https://github.com/OutfitKit/outfitkit vendor/outfitkit

Sirve vendor/outfitkit/dist/outfitkit.min.css desde tu backend. git submodule update --remote cuando quieras pullear cambios.

Opción C — copiar las fuentes y bundlear tú mismo:

git clone --depth 1 https://github.com/OutfitKit/outfitkit
# Copia css/ a tu repo, ejecuta tu propio bundler.

Útil solo si vas a forkearlo o necesitas modificar tokens. Para uso normal, sobra.

Importante: sea cual sea la opción, el helper css_url() siempre apunta a jsDelivr. Si self-hosteas, no uses css_url() — pasa la URL de tu static directamente.

Sitio de demos

Componentes en vivo con código fuente al lado, navegable: https://outfitkit.github.io/outfitkit/

Estructura del repositorio

outfitkit/
├── css/                ← fuentes CSS sin minificar (lo que editas)
│   ├── tokens.css      ← escalas globales y tokens compartidos
│   ├── base.css        ← reset + tipografía
│   ├── utilities.css   ← utilidades globales
│   ├── outfitkit.css   ← entry point con @import de todo
│   └── components/     ← 44 archivos, uno por familia (button, card, modal, ...)
├── dist/               ← bundles generados SOLO en CI al taggear (no editar a mano)
│   ├── outfitkit.css
│   ├── outfitkit.min.css
│   ├── outfitkit.ok.css      ← snapshot legacy de compatibilidad
│   └── outfitkit.ok.min.css
└── showcase/           ← macros Jinja + sitio de demos + paquete PyPI

Contribuir

Editar CSS

Edita los archivos en css/. Para previsualizar tus cambios:

<link rel="stylesheet" href="./css/outfitkit.css">

cargado desde un servidor local cualquiera (python3 -m http.server 8000). No hay build local. Cuando estés contento, push y abre PR.

Releases

El bundle minificado lo genera la Action css-build.yml al taggear:

git tag v3.0.0
git push origin v3.0.0

La Action concatena css/*.css, minifica con lightningcss-cli y commitea dist/outfitkit.{css,min.css} al tag. jsDelivr sirve @v3.0.0/dist/outfitkit.min.css y @latest automáticamente.

Convenciones

Naming

.block                  base                .card
.block__element         child element       .kanban__card
.state / utility        modifier            .primary, .lg, .outline, .block
.is-{state}             runtime state       .is-active, .is-open

Theming

Themes se aplican vía atributo data-theme en <html> o cualquier subárbol:

<html data-theme="erplora">  <!-- default, dark terracota -->
<html data-theme="dark">
<html data-theme="light">

Los componentes consumen el contrato global de tokens.css y modifiers.css. Para crear componentes nuevos o entender el patrón canónico, ver docs/COMPONENT-PATTERN.md.

Licencia

MIT.

Project details


Download files

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

Source Distribution

outfitkit-1.0.0.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

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

outfitkit-1.0.0-py3-none-any.whl (71.9 kB view details)

Uploaded Python 3

File details

Details for the file outfitkit-1.0.0.tar.gz.

File metadata

  • Download URL: outfitkit-1.0.0.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for outfitkit-1.0.0.tar.gz
Algorithm Hash digest
SHA256 46a001aeafc2e44399bb07bee914bc805e7cd528e4caf577830469c61e956896
MD5 3dd038c2fe3886c459e819464c90106c
BLAKE2b-256 7753d3ebc2acfbf03f9633e72f54442c2ebd163eb89ef75dd7bf68d5b0f4fe5a

See more details on using hashes here.

Provenance

The following attestation bundles were made for outfitkit-1.0.0.tar.gz:

Publisher: pypi-publish.yml on OutfitKit/outfitkit

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

File details

Details for the file outfitkit-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: outfitkit-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 71.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for outfitkit-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1e67bfd9fd1ce6f9e315f9a21528935a9388ea2a3149ee8372f9e98eb20de6e
MD5 656a7a2fa31d417936aca5ae7ac85d10
BLAKE2b-256 0b1e7cd69177e33e7b4b49156decb66a147ee327d510b992746f49053bc15793

See more details on using hashes here.

Provenance

The following attestation bundles were made for outfitkit-1.0.0-py3-none-any.whl:

Publisher: pypi-publish.yml on OutfitKit/outfitkit

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page