feat: support fully customized toasts #53

[jason-capsule42]

Alaska Airlines Pull Request

Type of change:

Please delete options that are not relevant.

• New capability
• Revision of an existing capability
• Infrastructure change (automation, etc.)
• Other (please elaborate)

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

Add support for fully customized toast notifications, enabling custom SVG icons, color customization, and the ability to disable auto-hide. Update documentation to reflect these new customization options.

New Features:

• Introduce support for fully customized toast notifications, allowing users to pass custom SVGs, recolor notifications, and disable auto-hide behavior.

Enhancements:

• Refactor toast component to handle custom SVG icons and improve the handling of toast visibility and auto-hide functionality.

Documentation:

• Update documentation to include instructions on customizing toast notifications, including using custom SVGs, recoloring, and disabling auto-hide.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR adds support for fully customizable toast notifications by introducing new features like custom SVG icons, color customization, and the ability to disable auto-hide behavior. The implementation modifies the core toast component to handle these new customization options and updates the documentation accordingly.

Updated class diagram for AuroToast component

classDiagram
    class AuroToast {
        Boolean visible
        String variant
        Boolean noIcon
        Boolean disableAutoHide
        clickToClose()
        fadeOutToast()
        getVariantIcon() HTMLElement
        handleSlotContent() void
    }
    note for AuroToast "Added disableAutoHide attribute and methods for custom SVG handling"

Loading

File-Level Changes

Change	Details	Files
Added support for custom toast notifications with new customization options	Added disableAutoHide property to prevent auto-hiding of toasts Added support for custom SVG icons through a new slot Added variant='custom' support for custom styling Added color customization through CSS custom properties	src/auro-toast.js
Refactored toast visibility and icon handling logic	Extracted variant icon logic into a separate getVariantIcon method Added handleSlotContent method to handle custom SVG injection Updated visibility handling to respect disableAutoHide setting Renamed handleOnClose to clickToClose for better clarity	src/auro-toast.js
Added comprehensive documentation and examples for new features	Added new section for customizing toast notifications Added example demonstrating custom SVG, colors, and auto-hide settings Updated API documentation with new properties Added new demo files for custom toast examples	demo/index.md docs/partials/index.md demo/api.md docs/api.md apiExamples/customToast.html apiExamples/customToast.js

---

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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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

Overall Comments:

• There are console.warn() and console.error() statements that should be removed from production code in getVariantIcon() and handleSlotContent()
• Please explain the reason for downgrading auro-library from 2.10.1 to ~2.8 in package.json

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟡 Documentation: 1 issue found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[jason-capsule42]

@sourcery-ai review

[sourcery-ai]

Hey @jason-capsule42 - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[jason-capsule42]

@sourcery-ai review

[sourcery-ai]

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

Overall Comments:

• Could you explain the reason for downgrading auro-library from ^2.10.1 to ~2.8? This seems like a potentially risky change that needs justification.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟡 Documentation: 2 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[jordanjones243]

Running a build:release causes the index.min.js and api.min.js causes the initExamples function export to be removed, therefore breaking the examples on the demo pages.

[jason-capsule42]

Running a build:release causes the index.min.js and api.min.js causes the initExamples function export to be removed, therefore breaking the examples on the demo pages.

This has been resolved.

[jordanjones243]

Two issues:

X icon does not look vertically centered when the notification icon is present

This error comes up when clicking the X button on new custom toast example

[blackfalcon]

🎉 This PR is included in version 2.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀