Skip to content

Prefer $scopedSlots to $slots

Mark Florian requested to merge vue-prefer-dollar-scopedslots into main

What does this MR do?

ci: Lint against $slots usage

Just ignore existing violations for now, since there are some subtleties when migrating from the $slots API to $scopedSlots. These will have to be migrated separately later.

The main subtlety is that these two expressions aren't equivalent:

Boolean(this.$slots.foo)

Boolean(this.$scopedSlots.foo)

The former evaluates to false if either the foo slot isn't provided, or if the provided foo slot has no content!

The latter only evaluates to false if the foo slot is not provided.

The simplest way to make these equivalent would be to call the slot function in the second case:

Boolean(this.$scopedSlots.foo())

But, depending on where this code lives, it may be called too often, or worse, have side effects.

The best way to migrate each of these will need to be worked out case-by-case.

Part of &8367.

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • [-] If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • [-] If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • [-] If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • [-] Added the ~"component:*" label(s) if applicable.

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" to aria-expanded="true" when an accordion is expanded.
  • [-] Color combinations have sufficient contrast.
Edited by Mark Florian

Merge request reports