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

🎉 (gdocs) add key-indicator-collection component #3108

Merged
merged 26 commits into from
Feb 15, 2024

Conversation

sophiamersmann
Copy link
Member

@sophiamersmann sophiamersmann commented Jan 17, 2024

Adds a new GDoc component, key-indicator-collection, that renders multiple key indicator components with navigational UI around it.

Example

Working example: Gdoc / Admin / Staging
Example with error states: Gdoc / Admin

[.+key-indicator-collection]

    {.key-indicator}
        datapageUrl: https://ourworldindata.org/grapher/child-mortality?time=earliest..latest
        title: What share of children died before their fifth birthday?
        [.+blurb]
            Blurb
        []
    {}

    {.key-indicator}
        datapageUrl: https://ourworldindata.org/grapher/share-of-population-in-extreme-poverty
        title: What share of the population is living in extreme poverty?
        [.+blurb]
            Blurb
        []
    {}

[]
Screenshot 2024-02-05 at 15 27 16

Details

  • When opening/closing an accordion item, the height is animated
    • height: auto can't be animated, so we have to keep track of the height of the content
      • aside: animating max-height (instead of height) doesn't work here because accordions are opened and closed at the same time; this would be out of sync if we used max-height since the opening animation would start immediately while the closing animation would appear to be a little delayed
    • keeping track of the height is implemented via a custom hook, useHeight
  • An accordion item might not be on screen after opening it. Since that can be disorienting, we smoothly scroll an accordion item into view after it has been opened
  • To show a map/chart icon, we need to know the config's tab property. It's stored with the linked chart (note that we're doing this for all linked charts)

@sophiamersmann
Copy link
Member Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

Copy link

coderabbitai bot commented Jan 23, 2024

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@sophiamersmann sophiamersmann force-pushed the gdoc-chart-book-component branch from d80513a to 1950d00 Compare January 24, 2024 09:52
@sophiamersmann sophiamersmann changed the title 🎉 (key-indicators) add gdoc chart book component 🎉 (gdocs) add key-indicator-collection component Jan 24, 2024
@sophiamersmann sophiamersmann force-pushed the gdoc-chart-book-component branch 2 times, most recently from ca05587 to 3aa2ce8 Compare January 25, 2024 11:43
@sophiamersmann sophiamersmann force-pushed the gdoc-key-indicator-block branch from bb1cfe6 to 7976a4a Compare January 29, 2024 09:29
@sophiamersmann sophiamersmann force-pushed the gdoc-chart-book-component branch 2 times, most recently from fa2c297 to c5a98c4 Compare January 29, 2024 10:25
@sophiamersmann sophiamersmann force-pushed the gdoc-key-indicator-block branch from 54692df to 8dc037c Compare January 29, 2024 10:28
@sophiamersmann sophiamersmann force-pushed the gdoc-chart-book-component branch 4 times, most recently from fda504f to 378a49f Compare January 30, 2024 09:40
@sophiamersmann sophiamersmann force-pushed the gdoc-key-indicator-block branch from 27487e5 to 503f01c Compare January 30, 2024 09:46
@sophiamersmann sophiamersmann force-pushed the gdoc-chart-book-component branch 2 times, most recently from afff1b5 to b03f2bb Compare February 1, 2024 09:11
@sophiamersmann sophiamersmann force-pushed the gdoc-key-indicator-block branch from 1cb21b7 to 1026548 Compare February 1, 2024 11:39
@sophiamersmann sophiamersmann force-pushed the gdoc-chart-book-component branch 2 times, most recently from 31770ac to 97a40fe Compare February 2, 2024 17:06
@sophiamersmann sophiamersmann force-pushed the gdoc-key-indicator-block branch from 8bb07e9 to 49056a3 Compare February 5, 2024 10:51
@sophiamersmann sophiamersmann force-pushed the gdoc-chart-book-component branch 2 times, most recently from 8a5f27d to 11d8e0d Compare February 5, 2024 11:20
@ikesau
Copy link
Member

ikesau commented Feb 15, 2024

Yup, you merge into master and I'll rebase 🙂

@ikesau ikesau force-pushed the gdoc-chart-book-component branch from 0ea7b51 to f7a1cb6 Compare February 15, 2024 20:04
@ikesau ikesau merged commit 69b0507 into gdoc-key-indicator-block Feb 15, 2024
13 of 15 checks passed
@ikesau ikesau deleted the gdoc-chart-book-component branch February 15, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants