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

chore: Updating the settings icon throughout the product #37330

Merged
merged 3 commits into from
Nov 12, 2024

Conversation

ankitakinger
Copy link
Contributor

@ankitakinger ankitakinger commented Nov 12, 2024

Description

Updating the settings icon throughout the product to use the below icon:
https://www.figma.com/design/8L9BXMzNTKboGWlHpdXyYP/Appsmith-IDE?node-id=33-3546&t=qpptzxhkWatrFIn1-4

Fixes #37248

Automation

/ok-to-test tags="@tag.Sanity"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11796204902
Commit: 0e57343
Cypress dashboard.
Tags: @tag.Sanity
Spec:


Tue, 12 Nov 2024 12:12:33 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • New Features

    • Updated icons for various settings-related components from "settings-2-line" to "settings-v3" to enhance visual representation.
  • Bug Fixes

    • Improved handling of frame ancestor settings in the AdminSettings configuration, ensuring better management of stored values.
  • Documentation

    • No changes to the documentation were made in this release.
  • Chores

    • Updated multiple components to reflect the new icon, maintaining overall functionality without introducing new logic.

@ankitakinger ankitakinger requested review from a team as code owners November 12, 2024 07:19
Copy link
Contributor

coderabbitai bot commented Nov 12, 2024

Walkthrough

The changes made in this pull request primarily involve updating the icon property in various configuration files and components from "settings-2-line" to "settings-v3". This update affects the visual representation of settings-related buttons and icons across multiple components, including the toolbar, admin settings, and various widgets. Additionally, some components have minor adjustments in their logic related to managing settings, particularly regarding local storage and rendering.

Changes

File Path Change Summary
app/client/packages/dsl/src/migrate/helpers/widget-configs.json Updated icon in buttonConfig from "settings-2-line" to "settings-v3" for OPEN_CONFIG_PANEL.
app/client/src/IDE/Components/ToolbarSettingsPopover.tsx Updated icon prop in ToggleButton from "settings-2-line" to "settings-v3".
app/client/src/ce/pages/AdminSettings/config/general.tsx Updated icon in config from "settings-2-line" to "settings-v3"; refined local storage logic.
app/client/src/ce/pages/Applications/WorkspaceMenu.tsx Updated icon in settings menu item from "settings-2-line" to "settings-v3".
app/client/src/components/propertyControls/DraggableListCard.tsx Updated startIcon prop for edit button from "settings-2-line" to "settings-v3".
app/client/src/modules/ui-builder/ui/wds/WDSMenuButtonWidget/config/propertyPaneConfig/contentConfig.ts Updated icon in buttonConfig from "settings-2-line" to "settings-v3".
app/client/src/pages/Editor/AppSettingsPane/AppSettings/index.tsx Updated icon for "General Settings" from "settings-2-line" to "settings-v3".
app/client/src/pages/Editor/gitSync/QuickGitActions/index.tsx Updated icon for Git settings button from "settings-2-line" to "settings-v3".
app/client/src/pages/Editor/gitSync/components/GitChangesList/StaticChange.tsx Updated iconName for StaticChangeKind.SETTINGS from "settings-2-line" to "settings-v3".
app/client/src/widgets/MenuButtonWidget/widget/propertyConfig/contentConfig.ts Updated icon in buttonConfig from "settings-2-line" to "settings-v3".
app/client/src/widgets/TableWidgetV2/widget/propertyConfig/PanelConfig/Basic.ts Updated icon in buttonConfig from "settings-2-line" to "settings-v3".

Assessment against linked issues

Objective Addressed Explanation
Update the settings icon used for the toolbar (37248)

Possibly related PRs

Suggested labels

Enhancement

Suggested reviewers

  • albinAppsmith
  • ayushpahwa

Poem

In the land of code where icons play,
A change was made, hip-hip-hooray!
From "settings-2-line" to "settings-v3",
A visual refresh for all to see!
With buttons gleaming, bright and new,
Our toolbar shines, just for you! 🌟


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 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.

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.

@github-actions github-actions bot added IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product Task A simple Todo skip-changelog Adding this label to a PR prevents it from being listed in the changelog labels Nov 12, 2024
@ankitakinger ankitakinger added the ok-to-test Required label for CI label Nov 12, 2024
@ankitakinger
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11792534401.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 37330.
recreate: .

Copy link
Contributor

@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: 2

🧹 Outside diff range and nitpick comments (1)
app/client/src/ce/pages/AdminSettings/config/general.tsx (1)

Line range hint 132-133: Remove eslint-disable comment

Consider fixing the TypeScript type instead of using eslint-disable.

-  // TODO: Fix this the next time the file is edited
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  parse: (value: { value: string; additionalData?: string }) => {
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 12ab7e6 and d5b45f3.

⛔ Files ignored due to path filters (1)
  • app/client/packages/design-system/ads/src/__assets__/icons/ads/settings-v3-icon.svg is excluded by !**/*.svg
📒 Files selected for processing (11)
  • app/client/packages/dsl/src/migrate/helpers/widget-configs.json (2 hunks)
  • app/client/src/IDE/Components/ToolbarSettingsPopover.tsx (1 hunks)
  • app/client/src/ce/pages/AdminSettings/config/general.tsx (1 hunks)
  • app/client/src/ce/pages/Applications/WorkspaceMenu.tsx (1 hunks)
  • app/client/src/components/propertyControls/DraggableListCard.tsx (1 hunks)
  • app/client/src/modules/ui-builder/ui/wds/WDSMenuButtonWidget/config/propertyPaneConfig/contentConfig.ts (1 hunks)
  • app/client/src/pages/Editor/AppSettingsPane/AppSettings/index.tsx (1 hunks)
  • app/client/src/pages/Editor/gitSync/QuickGitActions/index.tsx (1 hunks)
  • app/client/src/pages/Editor/gitSync/components/GitChangesList/StaticChange.tsx (1 hunks)
  • app/client/src/widgets/MenuButtonWidget/widget/propertyConfig/contentConfig.ts (1 hunks)
  • app/client/src/widgets/TableWidgetV2/widget/propertyConfig/PanelConfig/Basic.ts (1 hunks)
✅ Files skipped from review due to trivial changes (8)
  • app/client/packages/dsl/src/migrate/helpers/widget-configs.json
  • app/client/src/IDE/Components/ToolbarSettingsPopover.tsx
  • app/client/src/ce/pages/Applications/WorkspaceMenu.tsx
  • app/client/src/components/propertyControls/DraggableListCard.tsx
  • app/client/src/modules/ui-builder/ui/wds/WDSMenuButtonWidget/config/propertyPaneConfig/contentConfig.ts
  • app/client/src/pages/Editor/gitSync/QuickGitActions/index.tsx
  • app/client/src/widgets/MenuButtonWidget/widget/propertyConfig/contentConfig.ts
  • app/client/src/widgets/TableWidgetV2/widget/propertyConfig/PanelConfig/Basic.ts
🔇 Additional comments (2)
app/client/src/ce/pages/AdminSettings/config/general.tsx (2)

184-184: LGTM: Icon update aligns with design requirements

The icon change from "settings-2-line" to "settings-v3" matches the PR objective.


Line range hint 134-139: Verify localStorage usage in SSR context

The use of localStorage directly might cause issues during server-side rendering. Let's verify if this component is only rendered client-side.

Copy link

Deploy-Preview-URL: https://ce-37330.dp.appsmith.com

@ankitakinger
Copy link
Contributor Author

/build-deploy-preview skip-tests=true recreate=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11792769178.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 37330.
recreate: true.

Copy link

Deploy-Preview-URL: https://ce-37330.dp.appsmith.com

@ankitakinger
Copy link
Contributor Author

/build-deploy-preview skip-tests=true

Copy link

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/11796228172.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 37330.
recreate: .

Copy link
Contributor

@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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d5b45f3 and 0e57343.

📒 Files selected for processing (1)
  • app/client/src/pages/common/SearchBar/HomepageHeaderAction.tsx (1 hunks)

Copy link

Deploy-Preview-URL: https://ce-37330.dp.appsmith.com

@ankitakinger ankitakinger merged commit 91cf54b into release Nov 12, 2024
53 checks passed
@ankitakinger ankitakinger deleted the chore/update-settings-icon branch November 12, 2024 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
IDE Pod Issues that new developers face while exploring the IDE IDE Product Issues related to the IDE Product ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog Task A simple Todo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Update the settings icon used for the toolbar
2 participants