-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
enhancement: api docs accessibility updates (#2946)
- Loading branch information
1 parent
bbf5be8
commit c57b9cb
Showing
17 changed files
with
412 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <a href="{{ target_path ?: env.currentFileDestination }}#top" class="phpdocumentor-back-to-top" aria-label="Back To Top"><i class="fas fa-chevron-circle-up"></i></a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <header class="phpdocumentor-header phpdocumentor-section"> | ||
| {% include 'components/header-title.html.twig' %} | ||
| <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" aria-label="menu button"/> | ||
| <label class="phpdocumentor-header__menu-icon" for="menu-button"> | ||
| <i class="fas fa-bars"></i> | ||
| </label> | ||
| {{ include('components/search.html.twig') }} | ||
| {% include 'components/topnav.html.twig' %} | ||
| </header> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <a href="{{ link(on) ~ (at ? ('#' ~ at)) }}" class="headerlink" aria-label="header link"><i class="fas fa-link"></i></a> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| {% if depth == 1 %} | ||
| <h3 class="phpdocumentor-sidebar__root-namespace"> | ||
| <a href="{{ entry.url }}" class="{{ destinationPath|trim('/', 'left') == entry.url ? '-active' }}">{{ entry.title | shortFQSEN }}</a> | ||
| </h3> | ||
| {% endif %} | ||
| {% if entry.children.count > 0 %} | ||
| <ul class="phpdocumentor-list"> | ||
| {% for child in entry.children %} | ||
| <li> | ||
| <a href="{{ child.url }}" class="{{ destinationPath|trim('/', 'left') == child.url ? '-active' }}">{{ child.title | shortFQSEN }}</a> | ||
| {{ toc(child, 'components/menu.html.twig', maxDepth, depth) }} | ||
| </li> | ||
| {% endfor %} | ||
| </ul> | ||
| {% endif %} |
2 changes: 1 addition & 1 deletion
2
build/docs/.phpdoc/template/components/search-results.html.twig
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
build/docs/.phpdoc/template/components/sidebar.css.twig
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| .phpdocumentor-sidebar { | ||
| margin: 0; | ||
| overflow: hidden; | ||
| max-height: 0; | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { | ||
| padding: var(--spacing-xs) var(--spacing-md); | ||
| list-style: none; | ||
| margin: 0; | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar li { | ||
| white-space: nowrap; | ||
| text-overflow: ellipsis; | ||
| overflow: hidden; | ||
| padding: 0 0 var(--spacing-xxxs) var(--spacing-md); | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar abbr, | ||
| .phpdocumentor .phpdocumentor-sidebar a { | ||
| text-decoration: none; | ||
| border-bottom: none; | ||
| color: var(--text-color); | ||
| font-size: var(--text-md); | ||
| padding-left: 0; | ||
| transition: padding-left .4s ease-out; | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar a:hover, | ||
| .phpdocumentor .phpdocumentor-sidebar a.-active { | ||
| padding-left: 5px; | ||
| font-weight: 600; | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar__category > * { | ||
| border-left: 1px solid var(--primary-color-lighten); | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar__category { | ||
| margin-bottom: var(--spacing-lg); | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar__category-header { | ||
| font-size: var(--text-md); | ||
| margin-top: 0; | ||
| margin-bottom: var(--spacing-xs); | ||
| color: var(--link-color-primary); | ||
| font-weight: 600; | ||
| border-left: 0; | ||
| } | ||
|
|
||
| .phpdocumentor .phpdocumentor-sidebar__root-package, | ||
| .phpdocumentor .phpdocumentor-sidebar__root-namespace { | ||
| font-size: var(--text-md); | ||
| margin: 0; | ||
| padding-top: var(--spacing-xs); | ||
| padding-left: var(--spacing-md); | ||
| color: var(--text-color); | ||
| font-weight: normal; | ||
| } | ||
|
|
||
| @media (min-width: {{ breakpoints['md'] }}) { | ||
| .phpdocumentor-sidebar { | ||
| border-right: var(--sidebar-border-color) solid 1px; | ||
| } | ||
| } | ||
|
|
||
| .phpdocumentor-sidebar__menu-button { | ||
| position: absolute; | ||
| top: -100%; | ||
| left: -100%; | ||
| } | ||
|
|
||
| .phpdocumentor-sidebar__menu-icon { | ||
| font-size: var(--text-md); | ||
| font-weight: 600; | ||
| background: var(--primary-color-darker); | ||
| color: white; | ||
| margin: 0 0 var(--spacing-lg); | ||
| display: block; | ||
| padding: var(--spacing-sm); | ||
| text-align: center; | ||
| border-radius: 3px; | ||
| text-transform: uppercase; | ||
| letter-spacing: .15rem; | ||
| } | ||
|
|
||
| .phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { | ||
| max-height: 100%; | ||
| padding-top: var(--spacing-md); | ||
| } | ||
|
|
||
| @media (min-width: {{ breakpoints['md'] }}) { | ||
| .phpdocumentor-sidebar { | ||
| overflow: visible; | ||
| max-height: 100%; | ||
| } | ||
|
|
||
| .phpdocumentor-sidebar__menu-icon { | ||
| display: none; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
build/docs/.phpdoc/template/components/table-of-contents-entry.html.twig
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| <dt class="phpdocumentor-table-of-contents__entry -{{ type }} -{{ node.visibility }}"> | ||
| <a href="{{ link(node) }}" aria-label="{{ node.name }}">{{ node is property ? '$' }}{{ node.name }}{{ node is method or node is function ? '()' }}</a> | ||
| <span> | ||
| {% if node is constant %} = {{ node.value }}{% endif %} | ||
| {% if node is enumCase %}{% if node.value %} = {{ node.value }}{% endif %}{% endif %} | ||
| {% if node is property %} : {{ node.type ? node.type|route('class:short')|join('|')|raw : 'mixed' }}{% endif %} | ||
| {% if node is method or node is function %} : {{ node.response.type|route('class:short')|join('|')|raw }}{% endif %} | ||
| </span> | ||
| </dt> | ||
| {% if node.summary %} | ||
| <dd>{{ node.summary }}</dd> | ||
| {% endif %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Oops, something went wrong.