Skip to content

Commit

Permalink
edit docs/source/notes/*.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@juniors90
juniors90 committed Jan 6, 2022
1 parent 826417b commit 0dbe7d1
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Flask-FomanticUI (Building)
# Flask-FomanticUI

[![Build status](https://github.com/juniors90/Flask-FomanticUI/actions/workflows/testing-package.yml/badge.svg)](https://github.com/juniors90/Flask-FomanticUI/actions)
[![codecov](https://codecov.io/gh/juniors90/Flask-FomanticUI/branch/main/graph/badge.svg?token=YNCV9C9GIG)](https://codecov.io/gh/juniors90/Flask-FomanticUI)
Expand Down
52 changes: 29 additions & 23 deletions docs/source/notes/basic.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -181,29 +181,35 @@ Go to the :doc:`macros` page to see the detailed usage for these macros.
Configurations
--------------

+-----------------------------+---------------+------------------------------------------------------------------------------+
| Configuration Variable | Default Value | Description |
+=============================+===============+==============================================================================+
| FOMANTIC_SERVE_LOCAL | ``False`` | If set to ``True``, local resources will be used for ``load_*`` methods. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_BUTTON_STYLE | ``'primary'`` | Default form button style, will change to ``primary`` in next major release. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_BUTTON_SIZE | ``""`` | Default form button size. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_ICON_SIZE | ``None`` | Default icon size. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_ICON_COLOR | ``None`` | Default icon color, follow the context with ``currentColor`` if not set. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_MSG_CATEGORY | ``None'`` | Default flash message category. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_VIEW_TITLE | ``'View'`` | Default title for view icon of table actions. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_EDIT_TITLE | ``'Edit'`` | Default title for edit icon of table actions. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_DELETE_TITLE | ``'Delete'`` | Default title for delete icon of table actions. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_NEW_TITLE | ``'New'`` | Default title for new icon of table actions. |
+-----------------------------+---------------+------------------------------------------------------------------------------+
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| Configuration Variable | Default Value | Description |
+================================+======================+==============================================================================+
| FOMANTIC_SERVE_LOCAL | ``False`` | If set to ``True``, local resources will be used for ``load_*`` methods. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_BUTTON_STYLE | ``'primary'`` | Default form button style, will change to ``primary`` in next major release. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_BUTTON_SIZE | ``""`` | Default form button size. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_ICON_SIZE | ``None`` | Default icon size. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_ICON_COLOR | ``None`` | Default icon color, follow the context with ``currentColor`` if not set. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_MSG_CATEGORY | ``None'`` | Default flash message category. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_VIEW_TITLE | ``'View'`` | Default title for view icon of table actions. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_EDIT_TITLE | ``'Edit'`` | Default title for edit icon of table actions. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_DELETE_TITLE | ``'Delete'`` | Default title for delete icon of table actions. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_TABLE_NEW_TITLE | ``'New'`` | Default title for new icon of table actions. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_ERROR_HEADER | ``Action Forbidden`` | Default title for error message in a form field. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_CHECKBOX_HEADER_ERROR | ``Action Forbidden`` | Default title for error message in a form field of checkbox type. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+
| FOMANTIC_RADIO_HEADER_ERROR | ``Action Forbidden`` | Default title for error message in a form field of radio type. |
+--------------------------------+----------------------+------------------------------------------------------------------------------+

..
tip:: See :ref:`button_customization` to learn how to customize form buttons.
2 changes: 2 additions & 0 deletions docs/source/notes/macros.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ API
method="post",\
inverted=None,\
extra_classes=None,\
color_title=None,\
role="form",\
form_type="basic",\
horizontal_columns=('sixteen', 'sixteen', 'sixteen'),\
Expand All @@ -177,6 +178,7 @@ API
:param inverted: If ``True``, define a `inverted <https://fomantic-ui.com/collections/form.html#inverted>`_
form class. Default to ``None``.
:param extra_classes: The classes to add to the ``<form>``.
:param color_title: The color to add to the ``<form>`` title. Default to ``None``.
:param role: ``<form>`` role attribute.
:param form_type: One of ``inline``. See the
Fomantic docs for details on different form layouts.
Expand Down

0 comments on commit 0dbe7d1

Please sign in to comment.