AlaskaAirlines / auro-form

Custom element that ....
https://auro.alaskaair.com/components/auro/form
Apache License 2.0
0 stars 0 forks source link

feat: add `auro-combobox@2.1.4` #58

Open sun-mota opened 3 days ago

sun-mota commented 3 days ago

Alaska Airlines Pull Request

Before Submitting this pull request:

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I have performed a self-review of my own update.

Summary by Sourcery

Add the auro-combobox component to the project, enabling users to filter search results from a predefined list. Update build scripts and documentation to support the new component, and implement tests to ensure its functionality.

New Features:

Enhancements:

Documentation:

Tests:

sourcery-ai[bot] commented 3 days ago

Reviewer's Guide by Sourcery

This PR adds the auro-combobox component version 2.1.4 to the project. The combobox is a combination of dropdown, input, and menu components that allows users to filter search results from a predefined list as they type.

Class diagram for AuroCombobox component

classDiagram
    class AuroCombobox {
        - Boolean error
        - String setCustomValidity
        - String validity
        - Boolean disabled
        - Boolean noFilter
        - Object optionSelected
        - Boolean noValidate
        - Boolean required
        - Boolean triggerIcon
        - String type
        - String value
        - Boolean checkmark
        - Array availableOptions
        - Object optionActive
        - String msgSelectionMissing
        - String dropdownElementName
        - Object dropdownTag
        - String inputElementName
        - Object inputTag
        + focus() void
        + static register(name: String)
        + handleMenuOptions() void
        + generateOptionsArray() void
        + hideBib() void
        + showBib() void
        + configureDropdown() void
        + configureMenu() void
        + configureInput() void
        + handleInputValueChange() void
        + configureCombobox() void
        + performUpdate() void
        + firstUpdated() void
        + notifyReady() void
        + checkReadiness() void
        + readyActions() void
        + handleSlotChange() void
        + render() HTML
    }
    AuroCombobox --> LitElement
    AuroCombobox --> AuroFormValidation
    AuroCombobox --> AuroLibraryRuntimeUtils
    AuroCombobox --> AuroDropdown
    AuroCombobox --> AuroInput
    AuroCombobox --> AuroDependencyVersioning

File-Level Changes

Change Details Files
Added the main auro-combobox component implementation
  • Implemented core combobox functionality combining dropdown, input and menu components
  • Added filtering capabilities for search suggestions
  • Implemented keyboard navigation and accessibility features
  • Added support for custom events and persistent menu options
components/combobox/src/auro-combobox.js
components/combobox/src/style.scss
Added comprehensive test suite for the combobox component
  • Added tests for basic functionality and interactions
  • Added tests for filtering capabilities
  • Added tests for keyboard navigation
  • Added tests for accessibility features
components/combobox/test/auro-combobox.test.js
Added documentation and examples
  • Added API documentation with property, method, and event descriptions
  • Added usage examples including basic, airports, and dynamic menu examples
  • Added design specifications and notes
components/combobox/docs/api.md
components/combobox/demo/index.md
components/combobox/docs/partials/description.md
components/combobox/docs/partials/useCases.md
Added build configuration and dependencies
  • Added package.json with component dependencies and build scripts
  • Added version files for dropdown and input dependencies
  • Updated build scripts to include combobox component
components/combobox/package.json
src/dropdownVersion.js
src/form/components/inputVersion.js
package.json

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](https://app.sourcery.ai) 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](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).