Skip to main content

UI component library for Django Cotton

Project description

Django Cotton UI

An optional kit of accessible, themeable UI components for Django Cotton, built with Tailwind CSS v4 and Alpine.js.

📖 Documentation: django-cotton.com/ui

The docs cover installation, theming and every component with live examples.

Install

pip install django-cotton-ui

Add it to INSTALLED_APPS after django_cotton:

INSTALLED_APPS = [
    # ...
    "django_cotton",
    "django_cotton_ui",
]

Then wire up Tailwind v4 (scan the component templates, import the theme) and the Alpine bundle. See the installation guide for the full setup.

Usage

Components use the c-ui. prefix:

<c-ui.button variant="primary">Save</c-ui.button>
<c-ui.input name="email" label="Email" placeholder="you@example.com" />

<c-ui.card>
    <h3 class="font-semibold">Title</h3>
    <p>Content goes here.</p>
</c-ui.card>

Browse the full set with live examples in the component docs.

Requirements

  • Python ≥ 3.8 · Django ≥ 4.2 · django-cotton ≥ 2.5
  • Tailwind CSS v4 with a build step (the same setup any Tailwind project uses; the Play CDN and v3 won't work, as the kit's styles are compiled from your @source-scanned templates)
  • Alpine.js v3

License

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

django_cotton_ui-0.1.0.tar.gz (90.2 kB view details)

Uploaded Source

Built Distribution

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

django_cotton_ui-0.1.0-py3-none-any.whl (126.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_cotton_ui-0.1.0.tar.gz
  • Upload date:
  • Size: 90.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.0 Linux/6.17.0-1015-azure

File hashes

Hashes for django_cotton_ui-0.1.0.tar.gz
Algorithm Hash digest
SHA256 14ba543f94e3469d6a9d334d37192b78e88b73bca365cf17927eb9641ba737f6
MD5 de50cf85869d72f9b127ba653a993a99
BLAKE2b-256 cb5b6f674159a7ff86aac3bbcb2cbb31749d73fd6b20eb3040e90f91f120cecf

See more details on using hashes here.

File details

Details for the file django_cotton_ui-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: django_cotton_ui-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 126.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.0 Linux/6.17.0-1015-azure

File hashes

Hashes for django_cotton_ui-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9725d46fba3148e5aeb9f16d21eeba03c462f35603ffbeb7a93b383ba9436ff3
MD5 bcfdc66286e4fa1f4d7240ddc45f5931
BLAKE2b-256 cc185e8e76a27132b6100b960a298b11e0fcb8f9d6fb9af713eb0b571caa6738

See more details on using hashes here.

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