Skip to content

[Doc] Misc updates in TogglePassword docs #2214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 27, 2024
Merged

[Doc] Misc updates in TogglePassword docs #2214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 16 additions & 9 deletions src/TogglePassword/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ You can disable it by passing ``use_toggle_form_theme`` option to ``false``::

*Note*: If you choose to disable provided package form theme, you will have to handle styling by yourself.

.. _ux-password-customizing-labels-and-icons:

Customizing Labels and Icons
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -264,29 +266,34 @@ Then in your form, add your controller as an HTML attribute::
Usage without Symfony Forms
---------------------------

You can also use the TogglePassword with native HTML inputs:
You can also use the TogglePassword with native HTML inputs. Inside the ``stimulus_controller()``
function you can use the same :ref:`options to customize labels and icons <ux-password-customizing-labels-and-icons>`
shown in previous sections:

.. code-block:: html+twig

// ...
{# ... #}

<div class="toggle-password-container"> // Add "toggle-password-container" or a class that applies position: relative to this container.
{# add "toggle-password-container" or a class that applies "position: relative" to this container #}
<div class="toggle-password-container">
<label for="password">Password</label>
<input
id="password"
name="password"
type="password"
{{ stimulus_controller('symfony/ux-toggle-password/toggle-password', {
{# visibleLabel: 'Show password', // If you want to modify this label. #}
{# visibleIcon: 'Some svg icon', // If you want to modify this icon. #}
{# hiddenLabel: 'Hide password', // If you want to modify this label. #}
{# hiddenIcon: 'Some svg icon', // If you want to modify this icon. #}
buttonClasses: ['toggle-password-button'], // Add as many classes as you wish. "toggle-password-button" is needed to activate the default CSS.
visibleLabel: 'Show password',
visibleIcon: 'Name of some SVG icon',
hiddenLabel: 'Hide password',
hiddenIcon: 'Name of some SVG icon',
# you can add your own CSS classes if needed, but the following
# CSS class is required to activate the default styles
buttonClasses: ['toggle-password-button'],
}) }}
>
</div>

// ...
{# ... #}

Backward Compatibility promise
------------------------------
Expand Down