Skip to content
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

Jump to bottom

Update pst docs buttons #1502

Merged
merged 2 commits into from
Oct 16, 2023
Merged

Update pst docs buttons #1502

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10c2090
call them button-links
gabalafou Oct 3, 2023
25b15aa
copy edit
gabalafou Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 13 additions & 3 deletions docs/user_guide/web-components.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Below you can find some examples of the components created with the :code:`sphin

.. _badges-buttons:

Badges and buttons
==================
Badges and button-links
=======================

Here are some of the available badges:

Expand All @@ -29,7 +29,7 @@ Here are some of the available badges:
:bdg-secondary-line:`secondary outline`
:bdg-success-line:`success outline`

Here are some of the available buttons, also using semantic colors:
Here are some of the available button-style links, also using semantic colors:

.. grid:: auto

Expand Down Expand Up @@ -96,6 +96,16 @@ Here are some of the available buttons, also using semantic colors:

Dark

.. note::

`Sphinx Design buttons
<https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html>`__
are actually links, meaning they are rendered in HTML with ``<a>`` tags
instead of ``<button>``. Use them if you need a link to look like a button,
however, be aware that they do not follow accessibility best practices for
native button components such as using the correct `ARIA attributes
<https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/button_role>`__.

If in your site's `custom CSS file <custom-css>`_ you override the `CSS custom properties <css-variables>`_ ``--pst-color-*`` (where ``*`` is one of the semantic color names, such as ``primary``, ``danger``), badges and buttons will automatically use the custom color.

Cards
Expand Down