Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 4 additions & 80 deletions docs/source/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,85 +9,9 @@ If you want to install this package with support for all CONTRIB packages, you c

>>> pip install balderhub-html[all]

Contrib for ``balderhub-auth``
==============================

For activating this module, you need to install the package like shown below
.. toctree::
:caption: Contributions

.. code-block:: none

>>> pip install balderhub-html[auth]

Once installed you can use it.

Pages
-----

.. autoclass:: balderhub.html.contrib.auth.pages.LoginPage
:members:


Setup Features
--------------

.. autoclass:: balderhub.html.contrib.auth.setup_features.UserLoginFeature
:members:


Contrib for ``balderhub-crud``
==============================

For activating this module, you need to install the package like shown below

.. code-block:: none

>>> pip install balderhub-html[crud]

Once installed you can use it.

Field Callbacks
---------------

This BalderHub project provides field callbacks for almost every normal HTML element, that is provided by this package.
You can use it right away.


.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldCollectorCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldFillerCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxFillerFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputFillerFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectFillerFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.TextCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.ValueFromUrlCollectorFieldCallback
:members:


Field Callbacks Auto-Select Functions
-------------------------------------

This package does also provide functions to auto select the correct callback based on the given html element.

.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_collector_callback_type_for

.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_filler_callback_type_for
contrib/auth.rst
contrib/crud.rst
23 changes: 23 additions & 0 deletions docs/source/contrib/auth.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Contrib for ``balderhub-auth``
******************************

For activating this module, you need to install the package like shown below

.. code-block:: none

>>> pip install balderhub-html[auth]

Once installed you can use it.

Pages
=====

.. autoclass:: balderhub.html.contrib.auth.pages.LoginPage
:members:


Setup Features
==============

.. autoclass:: balderhub.html.contrib.auth.setup_features.UserLoginFeature
:members:
57 changes: 57 additions & 0 deletions docs/source/contrib/crud.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
Contrib for ``balderhub-crud``
******************************

For activating this module, you need to install the package like shown below

.. code-block:: none

>>> pip install balderhub-html[crud]

Once installed you can use it.

Field Callbacks
===============

This BalderHub project provides field callbacks for almost every normal HTML element, that is provided by this package.
You can use it right away.


.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldCollectorCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.BaseHtmlElemFieldFillerCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.CheckboxFillerFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.InputFillerFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.SelectFillerFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.TextCollectorFieldCallback
:members:

.. autoclass:: balderhub.html.contrib.crud.utils.field_callbacks.ValueFromUrlCollectorFieldCallback
:members:


Field Callbacks Auto-Select Functions
=====================================

This package does also provide functions to auto select the correct callback based on the given html element.

.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_collector_callback_type_for

.. autofunction:: balderhub.html.contrib.crud.utils.field_callbacks.get_field_filler_callback_type_for
Loading