Metadata-Version: 2.1
Name: django-ui-forms
Version: 1.1
Summary: A Django reusable app to extend forms with Bootstrap and Tailwind CSS support
Home-page: https://github.com/mohitprajapat2001/django-ui-forms
Author: Mohit Prajapat
Author-email: mohitdevelopment2001@gmail.com
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
License-File: LICENSE

# Django UI Forms

A Django reusable app to extend forms and provide UI with templates available for Bootstrap and Tailwind CSS.

https://pypi.org/project/django-ui-forms/

## Features

- Custom form handling with Bootstrap and Tailwind CSS support.
- Easy to use and integrate into existing Django projects.
- Flexible and reusable components for better form management.

## Installation

You can install this package via pip:

```bash
pip install django-ui-forms
```

## Usage

To use this package in your Django project, follow these steps:

1. Add `django_ui_forms` to your `INSTALLED_APPS` in your Django settings:

```python
INSTALLED_APPS = [
    ...
    'django_ui_forms',
]
```

2. Create your forms by extending `BootstrapBaseUiForms` or `TailwindBaseUiForms`:

```python
from django import forms
from django_ui_forms.forms import BootstrapBaseUiForms, TailwindBaseUiForms

class MyForm(BootstrapBaseUiForms, forms.Form):
    my_field = forms.CharField(label='My Field')

class MyModelForm(TailwindBaseUiForms, forms.ModelForm):
    class Meta:
        model = MyModel
        fields = '__all__'
```

3.  Update custom form renderer in your settings:

```python
from django.forms.renderers import TemplatesSetting

class CustomFormRenderer(TemplatesSetting):
form_template_name = "bootstrap_forms_snipprt.html" # for Bootstrap
form_template_name = "tailwind_forms_snipprt.html" # for Tailwind

FORM_RENDERER = 'your_project_name.settings.CustomFormRenderer'
```

4. Use the forms in your views and templates.

## Example

See the `examples/` directory for a complete example of how to use this package in a Django project.

## Running Tests

Tests are Under Development

## Contributing

Contributions are welcome! Please submit a pull request or open an issue.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
