Fix search box on alert and tooltip pages
What does this MR do?
Fix alert page search box
In production only, if you visit the /components/alert
page directly,
the sidebar's search box doesn't render.
In the console, there's this error:
DOMException: Node.appendChild: Cannot add children to a Text
> NuxtJS
This fix is bizarre.
Here are a couple of patches that fix the problem:
- Remove HTML syntax highlighting on a code block.
diff --git c/contents/components/alert.md i/contents/components/alert.md index f16c011b90..8aa2c65c02 100644 --- c/contents/components/alert.md +++ i/contents/components/alert.md @@ -117,7 +117,7 @@ Alerts don't handle their own visibility, so it's the parent component's responsbility to listen for the `dismiss` event and hide the alert in some way. For example: -```html +``` <script> ... computed: {
- Don't do property access at the beginning of an expression?
diff --git c/contents/components/alert.md w/contents/components/alert.md index 0697bc33f9..86155ad257 100644 --- c/contents/components/alert.md +++ w/contents/components/alert.md @@ -124,7 +124,7 @@ For example: ... computed: { shouldShowAlert() { - return !this.isAlertDismissed && this.someOtherCondition(); + return !isAlertDismissed && this.someOtherCondition(); }, }, ...
It appears that a minimal reproduction is to have a page with this in it:
```html
<script>a.b</script>
```
Figuring out why that breaks anything at all probably means digging into the guts of Nuxt. For now, we'll work around it.
Addresses #2953 (closed).
Fix tooltip page search box
Much like the previous commit, this fix is bizarre.
This time, the problem isn't property access at the beginning of an expression in a script tag of an HTML block, but:
- An import statement.
- A key/value pair in an object.
Both of these need to be removed to fix it:
diff --git c/contents/components/tooltip.md i/contents/components/tooltip.md
index 1098987200..5cabb038cc 100644
--- c/contents/components/tooltip.md
+++ i/contents/components/tooltip.md
@@ -134,11 +134,8 @@ You will need to import and register `GlTooltipDirective` before you can use it.
```html
<script>
-import { GlTooltipDirective } from '@gitlab/ui';
-
export default {
directives: {
- GlTooltip: GlTooltipDirective,
},
};
</script>
Instead, we mark it as plan text to work around the issue.
Addresses #2953 (closed).
Validating locally
yarn build
python3 -m http.server 3000 --bind localhost --directory public
- Visit http://localhost:3000/components/alert
- Observe search box renders
- Visit http://localhost:3000/components/tooltip
- Observe search box renders
Integrations
-
GitLab: mr_url -
CustomersDot: mr_url -
Duo UI: mr_url -
Status Page: mr_url -
Docs: mr_url -
Switchboard: mr_url
Does this MR meet the acceptance criteria?
This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.
Toggle the acceptance checklist
Conformity
-
The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”. - For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
-
Relevant label(s) are applied to the MR. -
The MR is added to a milestone. -
Added the ~"component:*"
label(s) if applicable. -
A changeset is added when this MR will do a patch, minor, or major update. More information can be found in doc/publishing-packages.md
.
Components
-
GitLab UI's contributing guidelines. -
If the MR changes a component's API, integration MR(s) have been opened (see integrations above).
Documentation
-
If creating a new component page from scratch, it follows the page template structure. -
Content follows the Pajamas voice and tone guidelines, falling back on the GitLab Documentation Style Guide when needed. -
Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter. -
If embedding a Figma file, it follows the Figma embed guide. -
Review requested from any GitLab designer or directly from a maintainer or trainee maintainer. -
Maintainer review follows the Pajamas UX maintainer review checklist.
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
Security reports checked/validated by a reviewer from the AppSec team
Accessibility
If this MR adds or modifies a component, take a few moments to review the following:
-
All actions and functionality can be done with a keyboard. -
Links, buttons, and controls have a visible focus state. -
All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label
for icons that have meaning or perform actions. -
Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false"
toaria-expanded="true"
when an accordion is expanded. -
Color combinations have sufficient contrast.
Related to #2953 (closed)