Skip to content

Conversation

@rmenner
Copy link
Contributor

@rmenner rmenner commented Sep 8, 2025

Alaska Airlines Pull Request

RC release #49

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

Implement fullBleed mode for auro-slideshow with custom alignment, dynamic width styling, and enhanced spacing, update API demos and documentation to reflect autoScroll naming and usage guidelines, and bump dependencies and build scripts for the RC #49 release

New Features:

  • Add fullBleed property to enable full-width slideshow previews with dynamic alignment and width calculations

Enhancements:

  • Switch slide spacing from fixed margins to CSS gap and tokenize dot animation timing and slide spacing variables
  • Import webcore type classes and refine carousel behavior with inViewThreshold and updated icon sizing

Build:

  • Bump dependency versions for icons, button, icon, library, design-tokens, webcore-stylesheets, and @auro-cli
  • Add build:version script and update dev script flags

Documentation:

  • Rename autoscroll attribute to autoScroll and update API examples, add usage notes for slide dimensions and mobile behavior
  • Revise README and docs to include fullBleed property, properties usage, and mobile navigation details

@rmenner rmenner requested a review from a team as a code owner September 8, 2025 17:52
@sourcery-ai
Copy link

sourcery-ai bot commented Sep 8, 2025

Reviewer's Guide

This release candidate adds a full-bleed display mode to the slideshow with custom alignment and dynamic width, refactors spacing and transition handling, standardizes the autoScroll attribute casing across code and docs, updates demos/README with refreshed metadata and stylesheet references, tweaks icon sizing in the component template, and bumps several package versions along with build scripts.

Entity relationship diagram for auro-slideshow properties

erDiagram
    AURO_SLIDESHOW {
      boolean autoScroll
      boolean autoplay
      number delay
      boolean fullBleed
      boolean loop
      boolean navigation
      boolean pagination
    }
    AURO_SLIDESHOW ||--o| SLIDE : contains
Loading

Updated class diagram for AuroSlideshow with fullBleed property and methods

classDiagram
    class AuroSlideshow {
      -playLabel: string
      -pauseLabel: string
      -playBtnLabel: string
      +fullBleed: boolean
      +initializeEmbla()
      +_createWidthProp()
      +_customAlign
      +_slideshowWrapperNode
      +_slideshowPaddingSize
    }
    AuroSlideshow <|-- LitElement
Loading

File-Level Changes

Change Details Files
FullBleed mode integration
  • introduce fullBleed property (default false) with reflect
  • add getters for slideshow wrapper node, padding size, and custom align callback
  • compute and set CSS --slideshow-width on init and resize
  • update Embla init options to use custom align and inViewThreshold
  • extend SCSS with host([fullBleed]) rules for full-bleed layout
src/auro-slideshow.js
src/style.scss
Refactor spacing and transition timing
  • replace fixed slide margin with CSS gap variable and import type classes
  • add --dot-animation-time and unify transition durations
  • introduce --slide-spacing and enforce box-sizing in container and slide
src/style.scss
Icon slot sizing adjustment
  • update icon render template to include inline style for --ds-auro-icon-size: inherit
src/auro-slideshow.js
Rename autoscroll to autoScroll
  • rename attribute in all example HTML files
  • update API docs and partials to use autoScroll property
  • adjust code examples in apiExamples and demo files
demo/api.html
demo/index.html
apiExamples/fullBleedAutoScroll.html
apiExamples/autoscroll.html
apiExamples/playoninit.html
apiExamples/scrollspeed.html
apiExamples/startdelay.html
docs/api.md
docs/partials/api.md
docs/partials/readmeAddlInfo.md
Update demos and README metadata
  • update demo HTML titles and comments for Prism, token, and webcore links
  • add new stylesheet references for Alaska theme
  • enhance README with slide width/height and activation notes
demo/api.html
demo/index.html
README.md
Bump dependencies and build scripts
  • upgrade @AuroDesignSystem and @alaskaairux package versions
  • bump aur CLI to v3.0.0 and add build:version script
  • update dev script flags and match button/icon version files
package.json
package-lock.json
src/buttonVersion.js
src/iconVersion.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. 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!

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

@rmenner rmenner linked an issue Sep 8, 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 there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/auro-slideshow.js:304` </location>
<code_context>
+   * Calculate the width of the slideshow-wrapper and attach a css property to the host element '--slideshow-width'
+   * @returns {void}
+   */
+  _createWidthProp = () => {
+    if (this._slideshowWrapperNode) {
+      const { width } = this._slideshowWrapperNode.getBoundingClientRect();
+
+      this.style.setProperty("--slideshow-width", `${width}px`);
+    }
+  };
+
</code_context>

<issue_to_address>
Consider debouncing _createWidthProp for resize events.

Frequent updates during rapid resize can degrade performance. Debounce or throttle _createWidthProp to reduce unnecessary DOM changes.

Suggested implementation:

```javascript
  /**
   * Debounce utility function
   * @param {Function} func
   * @param {number} wait
   * @returns {Function}
   */
  _debounce(func, wait) {
    let timeout;
    return (...args) => {
      clearTimeout(timeout);
      timeout = setTimeout(() => func.apply(this, args), wait);
    };
  }

  /**
   * Calculate the width of the slideshow-wrapper and attach a css property to the host element '--slideshow-width'
   * @returns {void}
   */
  _createWidthProp = () => {
    if (this._slideshowWrapperNode) {
      const { width } = this._slideshowWrapperNode.getBoundingClientRect();

      this.style.setProperty("--slideshow-width", `${width}px`);
    }
  };

  /**
   * Debounced version of _createWidthProp for resize events
   */
  _debouncedCreateWidthProp = this._debounce(this._createWidthProp, 100);

```

```javascript
    /** @private */
    this.playBtnLabel = this.playLabel;

    // Attach debounced resize event listener
    window.addEventListener('resize', this._debouncedCreateWidthProp);

```

- If you already have a debounce utility in your codebase, use that instead of the provided `_debounce` implementation.
- Make sure to remove or update any existing resize event listeners that use `_createWidthProp` directly.
- Consider cleaning up the event listener in the component's disconnectedCallback or equivalent teardown method to avoid memory leaks.
</issue_to_address>

### Comment 2
<location> `src/style.scss:207` </location>
<code_context>
   }
 }
+
+:host([loop]) {
+  .embla__container {
+    gap: unset;
+  }
+
+  .embla__slide {
</code_context>

<issue_to_address>
Unsetting gap for loop mode may cause inconsistent spacing.

Ensure only one spacing property is used at a time to prevent layout inconsistencies.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
:host([loop]) {
  .embla__container {
    gap: unset;
  }

  .embla__slide {
=======
:host([loop]) {
  .embla__container {
    gap: 0; // Ensure gap is explicitly set to 0 for loop mode
  }

  .embla__slide {
    margin-right: var(--slide-spacing, 0); // Use margin for spacing if needed, otherwise 0
  }
>>>>>>> REPLACE

</suggested_fix>

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.

@rmenner rmenner merged commit 122df24 into main Sep 8, 2025
18 of 19 checks passed
@rmenner rmenner deleted the rc/49 branch September 8, 2025 18:01
@github-actions
Copy link

github-actions bot commented Sep 8, 2025

🎉 This PR is included in version 1.2.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot added the released Completed work has been released label Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released Completed work has been released semantic-status: fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RC 2025-09-08

4 participants