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.

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

DOCS: Fix input span slotting #396

Merged
merged 1 commit into from
Mar 5, 2025
Merged

Conversation

DukeFerdinand
Copy link
Contributor

@DukeFerdinand DukeFerdinand commented Mar 5, 2025

All examples were using <slot slot= and this fixes it to use the proper <span slot=.

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Corrects the usage of span slotting in the auro-input component examples, replacing <slot slot= with the proper <span slot=. Also, updates the auro-formkit version in the README.

All examples were using `<slot slot=` and this fixes it to use the proper `<span slot=`.
@DukeFerdinand DukeFerdinand added the Type: Documentation Documentation only changes label Mar 5, 2025
@DukeFerdinand DukeFerdinand self-assigned this Mar 5, 2025
@DukeFerdinand DukeFerdinand requested a review from a team as a code owner March 5, 2025 22:58
Copy link

sourcery-ai bot commented Mar 5, 2025

Reviewer's Guide by Sourcery

This pull request fixes the slot syntax in the auro-input examples, replacing the incorrect <slot slot="..."> with the correct <span slot="...">. It also updates the auro-formkit version in the README.md file.

Updated class diagram for auro-input component

classDiagram
  class auro-input {
    -label: string
    -helptext: string
    +attributeChangedCallback(name: string, oldValue: any, newValue: any): void
  }
  note for auro-input "The slot syntax for label and helptext has been updated from <slot slot=...> to <span slot=...>"
Loading

File-Level Changes

Change Details Files
Updated the slot syntax in the auro-input examples from <slot slot="..."> to <span slot="...">.
  • Replaced <slot slot="label"> with <span slot="label"> in various examples.
  • Replaced <slot slot="helptext"> with <span slot="helptext"> in various examples.
components/input/apiExamples/activeLabel.html
components/input/apiExamples/creditCard.html
components/input/apiExamples/creditCardIcon.html
components/input/apiExamples/email.html
components/input/apiExamples/maxLength.html
components/input/apiExamples/minLength.html
components/input/apiExamples/noValidate.html
components/input/apiExamples/number.html
components/input/apiExamples/resetState.html
components/input/apiExamples/day.html
components/input/apiExamples/disabled.html
components/input/apiExamples/monthDayYear.html
components/input/apiExamples/monthYear.html
components/input/apiExamples/yearMonthDay.html
Updated the auro-formkit version in the README.md file.
  • Updated the auro-formkit version from 2.0.0 to 2.0.1 in the script tag.
components/input/README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@DukeFerdinand DukeFerdinand linked an issue Mar 5, 2025 that may be closed by this pull request
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @DukeFerdinand - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Good catch, using span instead of slot is the correct approach for named slots.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@DukeFerdinand DukeFerdinand merged commit e9d9a4a into main Mar 5, 2025
6 checks passed
@DukeFerdinand DukeFerdinand deleted the dhook/fix-auro-input-docs branch March 5, 2025 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Documentation only changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Input API doc example code is wrong
2 participants