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

Add new feature notice for dark mode #4922

Merged
merged 22 commits into from
Sep 18, 2024
Merged

Add new feature notice for dark mode #4922

merged 22 commits into from
Sep 18, 2024

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Sep 13, 2024

Fixes

Fixes #4157 by @fcoveram

Description

This PR

  • adds a new VFeatureNotice component that can be used for notifying people of new features
  • adds a component VDarkModeFeatureNotice that uses the above to notify people that we now have a dark mode
  • adds a spinning-glowing effect to the VSelectField based on the showNewHighlight boolean prop
  • adds some logic to hide the notice and glow once the user has interacted with the feature
  • does not add logic to remove the notice based on time because we can do that with cleanup in a subsequent deployment

Testing Instructions

  1. Check out the PR and run the dev server.
  2. Enable the "dark_mode_ui_toggle" feature.
  3. Navigate to the homepage. You should see the notice and the glow effect around theme selector.
  4. Click on the "See more" button in the notice or the theme selector. The notice and glow will go away, forever (or until you clear cookies).

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@openverse-bot openverse-bot added 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 🖼️ aspect: design Concerns related to design labels Sep 13, 2024
@dhruvkb
Copy link
Member Author

dhruvkb commented Sep 17, 2024

In accordance with #4936, the feature notice border has been changed to a single color instead of a gradient. The homepage color change should be a separate PR as that will involve some snapshot changes.

Copy link

Full-stack documentation: https://docs.openverse.org/_preview/4922

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Sorry you had to spend so much time with the snapshots, but I'm glad that they did find a [small] problem with the language select size. Fixing it is the blocking request for change.

frontend/src/components/VSelectField/VSelectField.vue Outdated Show resolved Hide resolved
@dhruvkb dhruvkb marked this pull request as ready for review September 18, 2024 16:16
@dhruvkb dhruvkb requested a review from a team as a code owner September 18, 2024 16:16
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Perfect ✨
Could you add a note in the Dark mode project to replace the link in the feature notice?

<template>
<VLink
:href="seeMoreHref"
class="group flex h-10 w-full flex-row items-center gap-2 rounded-full border border-secondary pe-4 ps-2 hover:no-underline sm:w-[23.125rem]"
Copy link
Contributor

Choose a reason for hiding this comment

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

In general, I don't like to have a fixed width for an element that has text because it might overflow if a different language has longer text. But I tried Russian, which is usually longer, and it seems to fit. Hopefully, all other languages do, too.

Copy link
Member Author

Choose a reason for hiding this comment

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

I did this because it was "Fixed" in Figma. When Francisco uses "Fixed" over "Hug", I usually see that as a sign that text is meant to wrap in those scenarios.

@@ -54,6 +54,8 @@ provide(ShowScrollButtonKey, showScrollButton)
<style scoped>
.app {
grid-template-areas: "header" "main";
/* This is used by some elements. */
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice addition! It would be useful for the focus ring outlines.

@dhruvkb dhruvkb merged commit 3ac6477 into main Sep 18, 2024
55 checks passed
@dhruvkb dhruvkb deleted the dark_mode_intro branch September 18, 2024 19:27
@dhruvkb dhruvkb mentioned this pull request Sep 18, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🖼️ aspect: design Concerns related to design ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Dark mode feature introduction flow
5 participants