.. auto generated by export_reference.py

**
UI
**

|development| |area|

A collection of resources for creating a user interface, similar to the Django admin, but for users.

**Version:** 4.0.0-d

**Provides**

- Compat
- Constants
- `Context Processors <https://docs.djangoproject.com/en/stable/ref/templates/api/#writing-your-own-context-processors>`_
- Descriptors
- Registry
- `Views <https://docs.djangoproject.com/en/stable/topics/http/views/>`_


Install
-------

Utilizing the UI system requires several additional setup steps.

You must first decide whether you want to load UI configurations automatically, or manage them manually.

.. tip::
    It is possible to use the built-in UI site with either manually or automatically added configurations. It is also
    possible to use the built-in UI site with additional manually created sites.

The settings to be added are:

- The UI app must be added to use automatic configuration.
- An HTML framework must be selected.
- Context processors will need to be included in template settings.
- The form renderer must be overridden.

Here is an excerpt from an example ``settings.py``:

.. code-block:: python

    # settings.py
    INSTALLED_APPS = [
        # ...
        'superdjango.assets.apps.DefaultConfig',
        'superdjango.html.frameworks.bootstrap4',
        'superdjango.ui.apps.AutoConfig',
    ]

    TEMPLATES = [
        {
            # ...
            'OPTIONS': {
                'context_processors': [
                    # ...
                    'superdjango.ui.context_processors.constants',
                    'superdjango.ui.context_processors.menu_items',
                ],
            },
        },
    ]
    FORM_RENDERER = 'django.forms.renderers.TemplatesSetting'

The ``urls.py`` file is the next thing to be updated.

- Include site URLs.
- For translation of UI JavaScript files, the JavaScriptCatalog must also be added.

.. code-block:: python

    # urls.py
    # ...
    from django.views.i18n import JavaScriptCatalog
    from superdjango.ui import site
    # ...

    urlpatterns = [
        # ...
        path('jsi18n/assets/', JavaScriptCatalog.as_view(packages=['superdjango.assets']), name='sd-javascript-catalog'),
        # Use apps/ (or whatever) or "" if the site is to serve all other URLs.
        path('apps/', include(site.get_urls())),
    ]

Then include the catalog URL in your base template:

.. code-block:: text

    <!-- this MUST come before form.media -->
    <script type="text/javascript" src="{% url 'sd-javascript-catalog' %}"></script>

    {% if form %}{{ form.media }}{% endif %}



.. _ui-ui-constants-developer:

Constants
=========


|development| |configuration|

Constants used within the UI.

Component Reference: :ref:`ui-ui-constants`

.. automodule:: superdjango.ui.constants
    :members:
    :show-inheritance:
    :special-members: __init__

.. _ui-ui-context_processors-developer:

Context Processors
==================


|development| |library|

Context processors for the UI

Component Reference: :ref:`ui-ui-context_processors`

.. automodule:: superdjango.ui.context_processors
    :members:
    :show-inheritance:
    :special-members: __init__

.. _ui-ui-options-developer:

Options
=======


|development| |library|

UI resources, once configured, may be transferred or output as runtime instances.

Component Reference: :ref:`ui-ui-options`

actions
-------

.. automodule:: superdjango.ui.options.actions
    :members:
    :show-inheritance:
    :special-members: __init__

controls
--------

.. automodule:: superdjango.ui.options.controls
    :members:
    :show-inheritance:
    :special-members: __init__

filters
-------

.. automodule:: superdjango.ui.options.filters
    :members:
    :show-inheritance:
    :special-members: __init__

interfaces
----------

.. automodule:: superdjango.ui.options.interfaces
    :members:
    :show-inheritance:
    :special-members: __init__

lists
-----

.. automodule:: superdjango.ui.options.lists
    :members:
    :show-inheritance:
    :special-members: __init__

menus
-----

.. automodule:: superdjango.ui.options.menus
    :members:
    :show-inheritance:
    :special-members: __init__

panels
------

.. automodule:: superdjango.ui.options.panels
    :members:
    :show-inheritance:
    :special-members: __init__

utils
-----

.. automodule:: superdjango.ui.options.utils
    :members:
    :show-inheritance:
    :special-members: __init__

views
-----

.. automodule:: superdjango.ui.options.views
    :members:
    :show-inheritance:
    :special-members: __init__

.. _ui-ui-runtime-developer:

Runtime
=======


|development| |library|

UI resources, once configured, may be transferred or output as runtime instances.

Component Reference: :ref:`ui-ui-runtime`

actions
-------

.. automodule:: superdjango.ui.runtime.actions
    :members:
    :show-inheritance:
    :special-members: __init__

data
----

.. automodule:: superdjango.ui.runtime.data
    :members:
    :show-inheritance:
    :special-members: __init__

filters
-------

.. automodule:: superdjango.ui.runtime.filters
    :members:
    :show-inheritance:
    :special-members: __init__

lists
-----

.. automodule:: superdjango.ui.runtime.lists
    :members:
    :show-inheritance:
    :special-members: __init__

menus
-----

.. automodule:: superdjango.ui.runtime.menus
    :members:
    :show-inheritance:
    :special-members: __init__

panels
------

.. automodule:: superdjango.ui.runtime.panels
    :members:
    :show-inheritance:
    :special-members: __init__

tools
-----

.. automodule:: superdjango.ui.runtime.tools
    :members:
    :show-inheritance:
    :special-members: __init__

.. _ui-ui-views-developer:

Views
=====


|development| |library|

Class-based views initialized for the UI

Component Reference: :ref:`ui-ui-views`

access
------

.. automodule:: superdjango.ui.views.access
    :members:
    :show-inheritance:
    :special-members: __init__

ajax
----

.. automodule:: superdjango.ui.views.ajax
    :members:
    :show-inheritance:
    :special-members: __init__

base
----

.. automodule:: superdjango.ui.views.base
    :members:
    :show-inheritance:
    :special-members: __init__

crud
----

.. automodule:: superdjango.ui.views.crud
    :members:
    :show-inheritance:
    :special-members: __init__

extended
--------

.. automodule:: superdjango.ui.views.extended
    :members:
    :show-inheritance:
    :special-members: __init__

forms
-----

.. automodule:: superdjango.ui.views.forms
    :members:
    :show-inheritance:
    :special-members: __init__

templates
---------

.. automodule:: superdjango.ui.views.templates
    :members:
    :show-inheritance:
    :special-members: __init__