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

BA: add dropzone aria label #157

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Conversation

anicioalexandre
Copy link
Collaborator

@anicioalexandre anicioalexandre commented Dec 12, 2024

  • design-system package update - v 0.0.23
    • Add InputProps prop and a default aria-label to the input.

Summary by CodeRabbit

  • New Features

    • Added a new property, InputProps, to the input component for enhanced customization and accessibility.
  • Bug Fixes

    • Improved accessibility of the Dropzone component by incorporating aria-label for input elements.
  • Chores

    • Updated version numbers for the @baseapp-frontend/components, @baseapp-frontend/design-system, and @baseapp-frontend/wagtail packages to reflect recent changes.

Copy link

changeset-bot bot commented Dec 12, 2024

⚠️ No Changeset found

Latest commit: 9dbc99e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Dec 12, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/design-system/components/Dropzone/index.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Cannot read config file: /packages/design-system/.eslintrc.js
Error: Cannot find module '@baseapp-frontend/config/.eslintrc.js'
Require stack:

  • /packages/design-system/.eslintrc.js
  • /node_modules/.pnpm/@eslint[email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli-engine/cli-engine.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/eslint.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/index.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/bin/eslint.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Module._load (node:internal/modules/cjs/loader:1074:27)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
    at Module.require (node:internal/modules/cjs/loader:1339:12)
    at require (node:internal/modules/helpers:135:16)
    at Object. (/packages/design-system/.eslintrc.js:1:18)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
    at Module.load (node:internal/modules/cjs/loader:1317:32)

Walkthrough

The changes in this pull request involve updates to the changelogs and version numbers for several packages within the @baseapp-frontend ecosystem. Specifically, the @baseapp-frontend/components package is updated to version 0.0.31, reflecting a dependency update for @baseapp-frontend/design-system to version 0.0.23. The @baseapp-frontend/design-system package introduces a new property, InputProps, enhancing the Dropzone component's accessibility. The @baseapp-frontend/wagtail package is also updated to version 1.0.7, documenting the dependency update.

Changes

File Change Summary
packages/components/CHANGELOG.md Updated to version 0.0.31, detailing dependency update for @baseapp-frontend/design-system to 0.0.23.
packages/components/package.json Version updated from 0.0.30 to 0.0.31.
packages/design-system/CHANGELOG.md Updated to version 0.0.23, introducing InputProps for the input component and accessibility changes.
packages/design-system/components/Dropzone/index.tsx Modified to include InputProps and aria-label for accessibility in input elements.
packages/design-system/components/Dropzone/types.ts Added InputProps property to DropzoneProps interface for additional input attributes.
packages/design-system/package.json Version updated from 0.0.22 to 0.0.23.
packages/wagtail/CHANGELOG.md Updated to version 1.0.7, documenting dependency update for @baseapp-frontend/design-system to 0.0.23.
packages/wagtail/package.json Version updated from 1.0.6 to 1.0.7.

Possibly related PRs

Suggested reviewers

  • deboracosilveira

🐰 In the garden of code, we hop with glee,
New props and updates, oh what a spree!
From components to changelogs, we dance and play,
With InputProps added, we brighten the day!
Version bumps ringing, like bells in the air,
Together in harmony, we code with care! 🌼✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/design-system/components/Dropzone/index.tsx (1)

53-54: Consider moving aria-label declaration outside render method

The aria-label is currently defined inside the render method, which means it's recreated on every render. Consider moving it outside to the component scope.

const Dropzone: FC<DropzoneProps> = ({
  // ... other props
}) => {
+ const DEFAULT_ARIA_LABEL = 'Drag and drop files to upload'
  const [files, setFiles] = useState<string | undefined>(storedImg)
  // ... other code

  const renderContent = () => {
-   const ariaLabel = 'Drag and drop files to upload'

    if (files)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a212a3 and 9dbc99e.

📒 Files selected for processing (8)
  • packages/components/CHANGELOG.md (1 hunks)
  • packages/components/package.json (1 hunks)
  • packages/design-system/CHANGELOG.md (1 hunks)
  • packages/design-system/components/Dropzone/index.tsx (3 hunks)
  • packages/design-system/components/Dropzone/types.ts (2 hunks)
  • packages/design-system/package.json (1 hunks)
  • packages/wagtail/CHANGELOG.md (1 hunks)
  • packages/wagtail/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (5)
  • packages/design-system/package.json
  • packages/wagtail/package.json
  • packages/components/CHANGELOG.md
  • packages/components/package.json
  • packages/wagtail/CHANGELOG.md
🔇 Additional comments (4)
packages/design-system/components/Dropzone/types.ts (1)

1-1: LGTM: Type definitions are properly structured

The addition of InputHTMLAttributes and InputProps follows React's typing conventions, allowing for proper type safety when passing HTML input attributes.

Also applies to: 22-22

packages/design-system/components/Dropzone/index.tsx (2)

26-26: LGTM: Props properly added to component interface

The InputProps is correctly destructured from props, maintaining consistency with the type definition.


58-58: Verify aria-label implementation across dropzone instances

The aria-label is properly implemented with the ability to override via InputProps. Let's verify this implementation across the codebase.

Also applies to: 75-75

✅ Verification successful

Aria-label implementation in Dropzone component is consistent and properly handled

The implementation shows that aria-label is consistently applied across both states of the Dropzone component (with and without files) with a default value of 'Drag and drop files to upload', while still allowing override through InputProps spread operator. No issues found in the implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for Dropzone component usage to verify aria-label implementation
rg -l "Dropzone" | xargs rg "<Dropzone.*InputProps.*aria-label"

Length of output: 63


Script:

#!/bin/bash
# Let's first find all Dropzone usages in the codebase
rg "<Dropzone" -A 3

# Also search for aria-label specifically within Dropzone component
rg "aria-label.*Dropzone|Dropzone.*aria-label" -A 3

Length of output: 1037


Script:

#!/bin/bash
# Let's check the actual implementation of aria-label in the Dropzone component
cat packages/design-system/components/Dropzone/index.tsx

# Also search for any test files related to Dropzone
fd "Dropzone.*test" --type f

Length of output: 3522

packages/design-system/CHANGELOG.md (1)

3-8: LGTM: Changelog properly documents the changes

The changelog entry follows semantic versioning and clearly documents both the addition of InputProps and the default aria-label.

@anicioalexandre anicioalexandre merged commit 3c2ea87 into master Dec 12, 2024
9 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant