django-unfold 0.30.0__tar.gz → 0.32.0__tar.gz

{django_unfold-0.30.0 → django_unfold-0.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-unfold
-Version: 0.30.0
+Version: 0.32.0
 Summary: Modern Django admin theme for seamless interface development
 Home-page: https://unfoldadmin.com
 License: MIT
@@ -33,7 +33,7 @@ Description-Content-Type: text/markdown
 ![Code Style - Ruff](https://img.shields.io/badge/code%20style-ruff-30173D.svg?style=for-the-badge)
 ![Pre Commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge)
 
-Unfold is theme for Django admin incorporating most common practises for building full-fledged admin areas. It is designed to work at the top of default administration provided by Django.
+Unfold is a theme for Django admin incorporating most common practices for building full-fledged admin areas. It is designed to work on top of default administration provided by Django.
 
 - **Unfold:** demo site is available at [unfoldadmin.com](https://unfoldadmin.com?utm_medium=github&utm_source=unfold)
 - **Formula:** repository with demo implementation at [github.com/unfoldadmin/formula](https://github.com/unfoldadmin/formula)
@@ -45,7 +45,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
 
 ## Features <!-- omit from toc -->
 
-- **Visual**: provides new user interface based on Tailwind CSS framework
+- **Visual**: provides a new user interface based on Tailwind CSS framework
 - **Sidebar:** simplifies definition of custom sidebar navigation with icons
 - **Dark mode:** supports both light and dark mode versions
 - **Configuration:** most of the basic options can be changed in settings.py
@@ -55,14 +55,16 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Array widget:** built-in widget for `django.contrib.postgres.fields.ArrayField`
 - **Filters:** custom dropdown, numeric, datetime, and text fields
 - **Dashboard:** custom components for rapid dashboard development
+- **Inline tabs:** group inlines into tab navigation in the change form
 - **Model tabs:** define custom tab navigations for models
-- **Fieldset tabs:** merge several fielsets into tabs in change form
-- **Colors:** possibility to override default color scheme
-- **Changeform modes:** display fields in changeform in compressed mode
+- **Fieldset tabs:** merge several fieldsets into tabs in the change form
+- **Colors:** possibility to override the default color scheme
+- **Changeform modes:** display fields in the change form in compressed mode
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
 - **Nonrelated inlines**: displays nonrelated model as inline in changeform
 - **Parallel admin**: support for default admin in parallel with Unfold. [Admin migration guide](https://unfoldadmin.com/blog/migrating-django-admin-unfold/?utm_medium=github&utm_source=unfold)
+- **Favicons**: built-in support for configuring various site favicons
 - **VS Code**: project configuration and development container is included
 
 ## Table of contents <!-- omit from toc -->
@@ -100,6 +102,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
   - [Overriding template](#overriding-template)
   - [Custom variables](#custom-variables)
   - [Unfold components](#unfold-components)
+    - [Table component example](#table-component-example)
 - [Unfold development](#unfold-development)
   - [Pre-commit](#pre-commit)
   - [Poetry configuration](#poetry-configuration)
@@ -111,7 +114,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
 
 ## Installation
 
-The installation process is minimal. Everything what is needed after installation is to put new application at the beginning of **INSTALLED_APPS**. Default admin configuration in urls.py can stay as it is and there are no changes required.
+The installation process is minimal. Everything that is needed after installation is to put new application at the beginning of **INSTALLED_APPS**. The default admin configuration in urls.py can stay as it is, and no changes are required.
 
 ```python
 # settings.py
@@ -170,17 +173,24 @@ class CustomAdminClass(ModelAdmin):
 
 from django.contrib import admin
 from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+from django.contrib.auth.admin import GroupAdmin as BaseGroupAdmin
 from django.contrib.auth.models import User
 
 from unfold.admin import ModelAdmin
 
 
 admin.site.unregister(User)
+admin.site.unregister(Group)
 
 
 @admin.register(User)
 class UserAdmin(BaseUserAdmin, ModelAdmin):
     pass
+
+
+@admin.register(Group)
+class GroupAdmin(BaseGroupAdmin, ModelAdmin):
+    pass
 ```
 
 ## Configuration
@@ -209,6 +219,14 @@ UNFOLD = {
         "dark": lambda request: static("logo-dark.svg"),  # dark mode
     },
     "SITE_SYMBOL": "speed",  # symbol from icon set
+    "SITE_FAVICONS": [
+        {
+            "rel": "icon",
+            "sizes": "32x32",
+            "type": "image/svg+xml",
+            "href": lambda request: static("favicon.svg"),
+        },
+    ],
     "SHOW_HISTORY": True, # show/hide "History" button, default: True
     "SHOW_VIEW_ON_SITE": True, # show/hide "View on site" button, default: True
     "ENVIRONMENT": "sample_app.environment_callback",
@@ -255,6 +273,7 @@ UNFOLD = {
             {
                 "title": _("Navigation"),
                 "separator": True,  # Top border
+                "collapsible": True,  # Collapsible group of links
                 "items": [
                     {
                         "title": _("Dashboard"),
@@ -345,6 +364,9 @@ class CustomAdminClass(ModelAdmin):
     # Display submit button in filters
     list_filter_submit = False
 
+    # Display changelist in fullwidth
+    list_fullwidth = False
+
     # Position horizontal scrollbar in changelist at the top
     list_horizontal_scrollbar_top = False
 
@@ -441,7 +463,7 @@ class UserAdmin(ModelAdmin):
     actions_detail = ["change_detail_action_block"]
     actions_submit_line = ["submit_line_action_activate"]
 
-    @action(description=_("Save & Activate"))
+    @action(description=_("Save & Activate"), permissions=["submit_line_action_activate"])
     def submit_line_action_activate(self, request: HttpRequest, obj: User):
         """
         If instance is modified in any way, it also needs to be saved,
@@ -453,6 +475,9 @@ class UserAdmin(ModelAdmin):
         obj.is_active = True
         obj.save()
 
+    def has_submit_line_action_activate_permission(self, request: HttpRequest, object_id: Union[str, int]):
+        pass
+
     @action(description=_("Import"), url_path="import")
     def changelist_global_action_import(self, request: HttpRequest):
         """
@@ -477,7 +502,7 @@ class UserAdmin(ModelAdmin):
         """
         return redirect(f"https://example.com/{object_id}")
 
-    @action(description=_("Detail"), url_path="detail-action", attrs={"target": "_blank"})
+    @action(description=_("Detail"), url_path="detail-action", attrs={"target": "_blank"}, permissions=["change_detail_action_block"])
     def change_detail_action_block(self, request: HttpRequest, object_id: int):
         """
         Handler for detail action.
@@ -492,6 +517,10 @@ class UserAdmin(ModelAdmin):
         return redirect(
             reverse_lazy("admin:users_user_change", args=(object_id,))
         )
+
+
+    def has_change_detail_action_block_permission(self, request: HttpRequest, object_id: Union[str, int]):
+        pass
 ```
 
 ### Action with form example
@@ -563,7 +592,7 @@ Text input field which allows filtering by the free string submitted by the user
 
 `FieldTextFilter` requires just a model field name and the filter will make `__icontains` search on this field. There are no other things to configure so the integration in `list_filter` will be just one new row looking like `("model_field_name", FieldTextFilter)`.
 
-In the case of the `TextFilter`, it is needed the write a whole new class inheriting from `TextFilter` with a custom implementation of the `queryset` method and the `parameter_name` attribute. This attribute will be a representation of the search query parameter name in URI. The benefit of the `TextFilter` is the possibility of writing complex queries.
+In the case of the `TextFilter`, it is needed to write a whole new class inheriting from `TextFilter` with a custom implementation of the `queryset` method and the `parameter_name` attribute. This attribute will be a representation of the search query parameter name in URI. The benefit of the `TextFilter` is the possibility of writing complex queries.
 
 ```python
 from django.contrib import admin
@@ -598,7 +627,7 @@ class MyAdmin(ModelAdmin):
 
 Dropdown filters will display a select field with a list of options. Unfold contains two types of dropdowns: `ChoicesDropdownFilter` and `RelatedDropdownFilter`.
 
-The difference between them is that `ChoicesDropdownFilter` will collect a list of options based on the `choices` attribute of the model field so most commonly it will be used in combination with `CharField` with specified `choices`.  On the other side, `RelatedDropdownFilter` needs a one-to-many or many-to-many foreign key to display options.
+The difference between them is that `ChoicesDropdownFilter` will collect a list of options based on the `choices` attribute of the model field so most commonly it will be used in combination with `CharField` with specified `choices`.  On the other hand, `RelatedDropdownFilter` needs a one-to-many or many-to-many foreign key to display options.
 
 **Note:** At the moment Unfold does not implement a dropdown with an autocomplete functionality, so it is important not to use dropdowns displaying large datasets.
 
@@ -907,6 +936,19 @@ class MyModelAdmin(ModelAdmin):
     )
 ```
 
+Inlines can be grouped into tab navigation by specifying `tab` attribute in the inline class.
+
+```python
+# admin.py
+
+from unfold.admin import TabularInline
+
+
+class MyInline(TabularInline):
+    model = User
+    tab = True
+```
+
 ## Third party packages
 
 ### django-celery-beat
@@ -976,11 +1018,11 @@ class ClockedScheduleAdmin(BaseClockedScheduleAdmin, ModelAdmin):
 
 ### django-guardian
 
-Adding support for django-guardian is quote straightforward in Unfold, just add `unfold.contrib.guardian` to `INSTALLED_APPS` at the beggining of the file. This action will override all templates coming from the django-guardian. Please note that **Object permissions** link is available in top right dropdown navigation.
+Adding support for django-guardian is quite straightforward in Unfold, just add `unfold.contrib.guardian` to `INSTALLED_APPS` at the beginning of the file. This action will override all templates coming from the django-guardian. Please note that **Object permissions** link is available in top right dropdown navigation.
 
 ### django-import-export
 
-1. Add `unfold.contrib.import_export` to `INSTALLED_APPS` at the beggining of the file. This action will override all templates coming from the application.
+1. Add `unfold.contrib.import_export` to `INSTALLED_APPS` at the beginning of the file. This action will override all templates coming from the application.
 2. Change `import_form_class` and `export_form_class` in ModelAdmin which is inheriting from `ImportExportModelAdmin`. This chunk of code is responsible for adding proper styling to form elements.
 
 ```python
@@ -1052,7 +1094,7 @@ This application is supported in Unfold by default. It is not needed to add any
 
 ### django-simple-history
 
-To make this application work, add `unfold.contrib.simple_history` into `settings.py` in `INSTALLED_APPS` variable before right after `unfold`. This app should ensure that templates coming from django-simple-history are overriden by Unfold.
+To make this application work, add `unfold.contrib.simple_history` into `settings.py` in `INSTALLED_APPS` variable before right after `unfold`. This app should ensure that templates coming from django-simple-history are overridden by Unfold.
 
 ## User Admin Form
 
@@ -1133,7 +1175,7 @@ npx tailwindcss -o your_project/static/css/styles.css --watch --minify
 
 ### Overriding template
 
-Create `templates/admin/index.html` in your project and paste the base template below into it. By default, all your custom styles here are not compiled because CSS classes are located in your specific project. Here it is needed to set up the Tailwind for your project and all requried instructions are located in [Project Level Tailwind Stylesheet](#project-level-tailwind-stylesheet) chapter.
+Create `templates/admin/index.html` in your project and paste the base template below into it. By default, all your custom styles here are not compiled because CSS classes are located in your specific project. Here it is needed to set up the Tailwind for your project and all required instructions are located in [Project Level Tailwind Stylesheet](#project-level-tailwind-stylesheet) chapter.
 
 ```html+django
 {% extends 'unfold/layouts/base_simple.html' %}
@@ -1237,25 +1279,53 @@ Below you can find a more complex example which is using multiple components and
 
 #### List of available components <!-- omit from toc -->
 
-| Component                         | Description                    | Arguments                        |
-| --------------------------------- | ------------------------------ | -------------------------------- |
-| unfold/components/chart/bar.html  | Bar chart implementation       | class, data, height, width       |
-| unfold/components/chart/line.html | Line chart implementation      | class, data, height, width       |
-| unfold/components/card.html       | Card component                 | class, title, footer, label      |
-| unfold/components/container.html  | Wrapper for settings max width | class                            |
-| unfold/components/flex.html       | Flex items                     | class, col                       |
-| unfold/components/navigation.html | List of navigation links       | class, items                     |
-| unfold/components/progress.html   | Percentual progress bar        | class, value, title, description |
-| unfold/components/separator.html  | Separator, horizontal rule     | class                            |
-| unfold/components/text.html       | Paragraph of text              | class                            |
-| unfold/components/title.html      | Basic heading element          | class                            |
-| unfold/components/button.html     | Basic button  element          | submit                           |
+| Component                         | Description                    | Arguments                            |
+| --------------------------------- | ------------------------------ | ------------------------------------ |
+| unfold/components/button.html     | Basic button element           | submit                               |
+| unfold/components/card.html       | Card component                 | class, title, footer, label, icon    |
+| unfold/components/chart/bar.html  | Bar chart implementation       | class, data, height, width           |
+| unfold/components/chart/line.html | Line chart implementation      | class, data, height, width           |
+| unfold/components/container.html  | Wrapper for settings max width | class                                |
+| unfold/components/flex.html       | Flex items                     | class, col                           |
+| unfold/components/icon.html       | Icon element                   | class                                |
+| unfold/components/navigation.html | List of navigation links       | class, items                         |
+| unfold/components/progress.html   | Percentual progress bar        | class, value, title, description     |
+| unfold/components/separator.html  | Separator, horizontal rule     | class                                |
+| unfold/components/table.html      | Table                          | table, card_included, striped        |
+| unfold/components/text.html       | Paragraph of text              | class                                |
+| unfold/components/title.html      | Basic heading element          | class                                |
+
+
+#### Table component example
+
+```python
+from typing import Dict
+from django.http import HttpRequest
+
+
+def dashboard_callback(request: HttpRequest) -> Dict:
+    return {
+        "table_data": {
+            "headers": ["col 1", "col 2"],
+            "rows": [
+                ["a", "b"],
+                ["c", "d"],
+            ]
+        }
+    }
+```
+
+```django-html
+{% component "unfold/components/card" with title="Card title" %}
+    {% component "unfold/components/table.html" with table=table_data card_included=1 striped=1 %}{% encomponent %}
+{% endcomponent %}
+```
 
 ## Unfold development
 
 ### Pre-commit
 
-Before adding any source code, it is recommended to have pre-commit installed on your local computer to check for all potential issues when comitting the code.
+Before adding any source code, it is recommended to have pre-commit installed on your local computer to check for all potential issues when committing the code.
 
 ```bash
 pip install pre-commit
@@ -1275,7 +1345,7 @@ To add a new feature or fix the easiest approach is to use django-unfold in comb
 
 ### Compiling Tailwind
 
-At the moment project contains package.json with all dependencies required to compile new CSS file. Tailwind configuration file is set to check all html, js and py files for Tailwind's classeses occurrences.
+At the moment project contains package.json with all dependencies required to compile new CSS file. Tailwind configuration file is set to check all html, js and py files for Tailwind's classes occurrences.
 
 ```bash
 npm install
@@ -1285,7 +1355,7 @@ npm run tailwind:watch # run after each change in code
 npm run tailwind:build # run once
 ```
 
-Some components like datepickers, calendars or selectors in admin was not possible to style by overriding html templates so their default styles are overriden in **styles.css**.
+Some components like datepickers, calendars or selectors in admin was not possible to style by overriding html templates so their default styles are overridden in **styles.css**.
 
 **Note:** most of the custom styles located in style.css are created via `@apply some-tailwind-class;` as is not possible to manually add CSS class to element which are for example created via jQuery.
 

{django_unfold-0.30.0 → django_unfold-0.32.0}/README.md

@@ -9,7 +9,7 @@
 ![Code Style - Ruff](https://img.shields.io/badge/code%20style-ruff-30173D.svg?style=for-the-badge)
 ![Pre Commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge)
 
-Unfold is theme for Django admin incorporating most common practises for building full-fledged admin areas. It is designed to work at the top of default administration provided by Django.
+Unfold is a theme for Django admin incorporating most common practices for building full-fledged admin areas. It is designed to work on top of default administration provided by Django.
 
 - **Unfold:** demo site is available at [unfoldadmin.com](https://unfoldadmin.com?utm_medium=github&utm_source=unfold)
 - **Formula:** repository with demo implementation at [github.com/unfoldadmin/formula](https://github.com/unfoldadmin/formula)
@@ -21,7 +21,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
 
 ## Features <!-- omit from toc -->
 
-- **Visual**: provides new user interface based on Tailwind CSS framework
+- **Visual**: provides a new user interface based on Tailwind CSS framework
 - **Sidebar:** simplifies definition of custom sidebar navigation with icons
 - **Dark mode:** supports both light and dark mode versions
 - **Configuration:** most of the basic options can be changed in settings.py
@@ -31,14 +31,16 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Array widget:** built-in widget for `django.contrib.postgres.fields.ArrayField`
 - **Filters:** custom dropdown, numeric, datetime, and text fields
 - **Dashboard:** custom components for rapid dashboard development
+- **Inline tabs:** group inlines into tab navigation in the change form
 - **Model tabs:** define custom tab navigations for models
-- **Fieldset tabs:** merge several fielsets into tabs in change form
-- **Colors:** possibility to override default color scheme
-- **Changeform modes:** display fields in changeform in compressed mode
+- **Fieldset tabs:** merge several fieldsets into tabs in the change form
+- **Colors:** possibility to override the default color scheme
+- **Changeform modes:** display fields in the change form in compressed mode
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
 - **Nonrelated inlines**: displays nonrelated model as inline in changeform
 - **Parallel admin**: support for default admin in parallel with Unfold. [Admin migration guide](https://unfoldadmin.com/blog/migrating-django-admin-unfold/?utm_medium=github&utm_source=unfold)
+- **Favicons**: built-in support for configuring various site favicons
 - **VS Code**: project configuration and development container is included
 
 ## Table of contents <!-- omit from toc -->
@@ -76,6 +78,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
   - [Overriding template](#overriding-template)
   - [Custom variables](#custom-variables)
   - [Unfold components](#unfold-components)
+    - [Table component example](#table-component-example)
 - [Unfold development](#unfold-development)
   - [Pre-commit](#pre-commit)
   - [Poetry configuration](#poetry-configuration)
@@ -87,7 +90,7 @@ Did you decide to start using Unfold but you don't have time to make the switch
 
 ## Installation
 
-The installation process is minimal. Everything what is needed after installation is to put new application at the beginning of **INSTALLED_APPS**. Default admin configuration in urls.py can stay as it is and there are no changes required.
+The installation process is minimal. Everything that is needed after installation is to put new application at the beginning of **INSTALLED_APPS**. The default admin configuration in urls.py can stay as it is, and no changes are required.
 
 ```python
 # settings.py
@@ -146,17 +149,24 @@ class CustomAdminClass(ModelAdmin):
 
 from django.contrib import admin
 from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+from django.contrib.auth.admin import GroupAdmin as BaseGroupAdmin
 from django.contrib.auth.models import User
 
 from unfold.admin import ModelAdmin
 
 
 admin.site.unregister(User)
+admin.site.unregister(Group)
 
 
 @admin.register(User)
 class UserAdmin(BaseUserAdmin, ModelAdmin):
     pass
+
+
+@admin.register(Group)
+class GroupAdmin(BaseGroupAdmin, ModelAdmin):
+    pass
 ```
 
 ## Configuration
@@ -185,6 +195,14 @@ UNFOLD = {
         "dark": lambda request: static("logo-dark.svg"),  # dark mode
     },
     "SITE_SYMBOL": "speed",  # symbol from icon set
+    "SITE_FAVICONS": [
+        {
+            "rel": "icon",
+            "sizes": "32x32",
+            "type": "image/svg+xml",
+            "href": lambda request: static("favicon.svg"),
+        },
+    ],
     "SHOW_HISTORY": True, # show/hide "History" button, default: True
     "SHOW_VIEW_ON_SITE": True, # show/hide "View on site" button, default: True
     "ENVIRONMENT": "sample_app.environment_callback",
@@ -231,6 +249,7 @@ UNFOLD = {
             {
                 "title": _("Navigation"),
                 "separator": True,  # Top border
+                "collapsible": True,  # Collapsible group of links
                 "items": [
                     {
                         "title": _("Dashboard"),
@@ -321,6 +340,9 @@ class CustomAdminClass(ModelAdmin):
     # Display submit button in filters
     list_filter_submit = False
 
+    # Display changelist in fullwidth
+    list_fullwidth = False
+
     # Position horizontal scrollbar in changelist at the top
     list_horizontal_scrollbar_top = False
 
@@ -417,7 +439,7 @@ class UserAdmin(ModelAdmin):
     actions_detail = ["change_detail_action_block"]
     actions_submit_line = ["submit_line_action_activate"]
 
-    @action(description=_("Save & Activate"))
+    @action(description=_("Save & Activate"), permissions=["submit_line_action_activate"])
     def submit_line_action_activate(self, request: HttpRequest, obj: User):
         """
         If instance is modified in any way, it also needs to be saved,
@@ -429,6 +451,9 @@ class UserAdmin(ModelAdmin):
         obj.is_active = True
         obj.save()
 
+    def has_submit_line_action_activate_permission(self, request: HttpRequest, object_id: Union[str, int]):
+        pass
+
     @action(description=_("Import"), url_path="import")
     def changelist_global_action_import(self, request: HttpRequest):
         """
@@ -453,7 +478,7 @@ class UserAdmin(ModelAdmin):
         """
         return redirect(f"https://example.com/{object_id}")
 
-    @action(description=_("Detail"), url_path="detail-action", attrs={"target": "_blank"})
+    @action(description=_("Detail"), url_path="detail-action", attrs={"target": "_blank"}, permissions=["change_detail_action_block"])
     def change_detail_action_block(self, request: HttpRequest, object_id: int):
         """
         Handler for detail action.
@@ -468,6 +493,10 @@ class UserAdmin(ModelAdmin):
         return redirect(
             reverse_lazy("admin:users_user_change", args=(object_id,))
         )
+
+
+    def has_change_detail_action_block_permission(self, request: HttpRequest, object_id: Union[str, int]):
+        pass
 ```
 
 ### Action with form example
@@ -539,7 +568,7 @@ Text input field which allows filtering by the free string submitted by the user
 
 `FieldTextFilter` requires just a model field name and the filter will make `__icontains` search on this field. There are no other things to configure so the integration in `list_filter` will be just one new row looking like `("model_field_name", FieldTextFilter)`.
 
-In the case of the `TextFilter`, it is needed the write a whole new class inheriting from `TextFilter` with a custom implementation of the `queryset` method and the `parameter_name` attribute. This attribute will be a representation of the search query parameter name in URI. The benefit of the `TextFilter` is the possibility of writing complex queries.
+In the case of the `TextFilter`, it is needed to write a whole new class inheriting from `TextFilter` with a custom implementation of the `queryset` method and the `parameter_name` attribute. This attribute will be a representation of the search query parameter name in URI. The benefit of the `TextFilter` is the possibility of writing complex queries.
 
 ```python
 from django.contrib import admin
@@ -574,7 +603,7 @@ class MyAdmin(ModelAdmin):
 
 Dropdown filters will display a select field with a list of options. Unfold contains two types of dropdowns: `ChoicesDropdownFilter` and `RelatedDropdownFilter`.
 
-The difference between them is that `ChoicesDropdownFilter` will collect a list of options based on the `choices` attribute of the model field so most commonly it will be used in combination with `CharField` with specified `choices`.  On the other side, `RelatedDropdownFilter` needs a one-to-many or many-to-many foreign key to display options.
+The difference between them is that `ChoicesDropdownFilter` will collect a list of options based on the `choices` attribute of the model field so most commonly it will be used in combination with `CharField` with specified `choices`.  On the other hand, `RelatedDropdownFilter` needs a one-to-many or many-to-many foreign key to display options.
 
 **Note:** At the moment Unfold does not implement a dropdown with an autocomplete functionality, so it is important not to use dropdowns displaying large datasets.
 
@@ -883,6 +912,19 @@ class MyModelAdmin(ModelAdmin):
     )
 ```
 
+Inlines can be grouped into tab navigation by specifying `tab` attribute in the inline class.
+
+```python
+# admin.py
+
+from unfold.admin import TabularInline
+
+
+class MyInline(TabularInline):
+    model = User
+    tab = True
+```
+
 ## Third party packages
 
 ### django-celery-beat
@@ -952,11 +994,11 @@ class ClockedScheduleAdmin(BaseClockedScheduleAdmin, ModelAdmin):
 
 ### django-guardian
 
-Adding support for django-guardian is quote straightforward in Unfold, just add `unfold.contrib.guardian` to `INSTALLED_APPS` at the beggining of the file. This action will override all templates coming from the django-guardian. Please note that **Object permissions** link is available in top right dropdown navigation.
+Adding support for django-guardian is quite straightforward in Unfold, just add `unfold.contrib.guardian` to `INSTALLED_APPS` at the beginning of the file. This action will override all templates coming from the django-guardian. Please note that **Object permissions** link is available in top right dropdown navigation.
 
 ### django-import-export
 
-1. Add `unfold.contrib.import_export` to `INSTALLED_APPS` at the beggining of the file. This action will override all templates coming from the application.
+1. Add `unfold.contrib.import_export` to `INSTALLED_APPS` at the beginning of the file. This action will override all templates coming from the application.
 2. Change `import_form_class` and `export_form_class` in ModelAdmin which is inheriting from `ImportExportModelAdmin`. This chunk of code is responsible for adding proper styling to form elements.
 
 ```python
@@ -1028,7 +1070,7 @@ This application is supported in Unfold by default. It is not needed to add any
 
 ### django-simple-history
 
-To make this application work, add `unfold.contrib.simple_history` into `settings.py` in `INSTALLED_APPS` variable before right after `unfold`. This app should ensure that templates coming from django-simple-history are overriden by Unfold.
+To make this application work, add `unfold.contrib.simple_history` into `settings.py` in `INSTALLED_APPS` variable before right after `unfold`. This app should ensure that templates coming from django-simple-history are overridden by Unfold.
 
 ## User Admin Form
 
@@ -1109,7 +1151,7 @@ npx tailwindcss -o your_project/static/css/styles.css --watch --minify
 
 ### Overriding template
 
-Create `templates/admin/index.html` in your project and paste the base template below into it. By default, all your custom styles here are not compiled because CSS classes are located in your specific project. Here it is needed to set up the Tailwind for your project and all requried instructions are located in [Project Level Tailwind Stylesheet](#project-level-tailwind-stylesheet) chapter.
+Create `templates/admin/index.html` in your project and paste the base template below into it. By default, all your custom styles here are not compiled because CSS classes are located in your specific project. Here it is needed to set up the Tailwind for your project and all required instructions are located in [Project Level Tailwind Stylesheet](#project-level-tailwind-stylesheet) chapter.
 
 ```html+django
 {% extends 'unfold/layouts/base_simple.html' %}
@@ -1213,25 +1255,53 @@ Below you can find a more complex example which is using multiple components and
 
 #### List of available components <!-- omit from toc -->
 
-| Component                         | Description                    | Arguments                        |
-| --------------------------------- | ------------------------------ | -------------------------------- |
-| unfold/components/chart/bar.html  | Bar chart implementation       | class, data, height, width       |
-| unfold/components/chart/line.html | Line chart implementation      | class, data, height, width       |
-| unfold/components/card.html       | Card component                 | class, title, footer, label      |
-| unfold/components/container.html  | Wrapper for settings max width | class                            |
-| unfold/components/flex.html       | Flex items                     | class, col                       |
-| unfold/components/navigation.html | List of navigation links       | class, items                     |
-| unfold/components/progress.html   | Percentual progress bar        | class, value, title, description |
-| unfold/components/separator.html  | Separator, horizontal rule     | class                            |
-| unfold/components/text.html       | Paragraph of text              | class                            |
-| unfold/components/title.html      | Basic heading element          | class                            |
-| unfold/components/button.html     | Basic button  element          | submit                           |
+| Component                         | Description                    | Arguments                            |
+| --------------------------------- | ------------------------------ | ------------------------------------ |
+| unfold/components/button.html     | Basic button element           | submit                               |
+| unfold/components/card.html       | Card component                 | class, title, footer, label, icon    |
+| unfold/components/chart/bar.html  | Bar chart implementation       | class, data, height, width           |
+| unfold/components/chart/line.html | Line chart implementation      | class, data, height, width           |
+| unfold/components/container.html  | Wrapper for settings max width | class                                |
+| unfold/components/flex.html       | Flex items                     | class, col                           |
+| unfold/components/icon.html       | Icon element                   | class                                |
+| unfold/components/navigation.html | List of navigation links       | class, items                         |
+| unfold/components/progress.html   | Percentual progress bar        | class, value, title, description     |
+| unfold/components/separator.html  | Separator, horizontal rule     | class                                |
+| unfold/components/table.html      | Table                          | table, card_included, striped        |
+| unfold/components/text.html       | Paragraph of text              | class                                |
+| unfold/components/title.html      | Basic heading element          | class                                |
+
+
+#### Table component example
+
+```python
+from typing import Dict
+from django.http import HttpRequest
+
+
+def dashboard_callback(request: HttpRequest) -> Dict:
+    return {
+        "table_data": {
+            "headers": ["col 1", "col 2"],
+            "rows": [
+                ["a", "b"],
+                ["c", "d"],
+            ]
+        }
+    }
+```
+
+```django-html
+{% component "unfold/components/card" with title="Card title" %}
+    {% component "unfold/components/table.html" with table=table_data card_included=1 striped=1 %}{% encomponent %}
+{% endcomponent %}
+```
 
 ## Unfold development
 
 ### Pre-commit
 
-Before adding any source code, it is recommended to have pre-commit installed on your local computer to check for all potential issues when comitting the code.
+Before adding any source code, it is recommended to have pre-commit installed on your local computer to check for all potential issues when committing the code.
 
 ```bash
 pip install pre-commit
@@ -1251,7 +1321,7 @@ To add a new feature or fix the easiest approach is to use django-unfold in comb
 
 ### Compiling Tailwind
 
-At the moment project contains package.json with all dependencies required to compile new CSS file. Tailwind configuration file is set to check all html, js and py files for Tailwind's classeses occurrences.
+At the moment project contains package.json with all dependencies required to compile new CSS file. Tailwind configuration file is set to check all html, js and py files for Tailwind's classes occurrences.
 
 ```bash
 npm install
@@ -1261,7 +1331,7 @@ npm run tailwind:watch # run after each change in code
 npm run tailwind:build # run once
 ```
 
-Some components like datepickers, calendars or selectors in admin was not possible to style by overriding html templates so their default styles are overriden in **styles.css**.
+Some components like datepickers, calendars or selectors in admin was not possible to style by overriding html templates so their default styles are overridden in **styles.css**.
 
 **Note:** most of the custom styles located in style.css are created via `@apply some-tailwind-class;` as is not possible to manually add CSS class to element which are for example created via jQuery.
 

{django_unfold-0.30.0 → django_unfold-0.32.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-unfold"
-version = "0.30.0"
+version = "0.32.0"
 description = "Modern Django admin theme for seamless interface development"
 license = "MIT"
 readme = "README.md"