feat(explore): Color scheme groups, new color schemes

[kgabryje]

SUMMARY

• adds a bunch of new color schemes
• groups the color schemes in categories: Custom (for color schemes added by users in config), Featured and Other
• Adds option group handling to Select and AsyncSelect

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Screen.Recording.2024-04-11.at.18.44.54.mov

TESTING INSTRUCTIONS

1. Test Select and AsyncSelect components with groups in storybook
2. Add some custom color schemes in config
3. Go to Explore and open a viz that has categorical color scheme control (for example Pie chart)
4. Open color scheme dropdown
5. Verify that your custom color scheme is in Custom group, the rest of the color schemes should be in groups Featured or Other

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

[michael-s-molina]

@kgabryje I have some questions about how this behavior will work with some of the requirements/features of the Select component:

• Selected items are always sorted first. How will that work with groups?
• We allow new items. Where will they be placed?
• What's the interaction with Select All?

Have we considered implementing this outside of the Select component? Like a radio group that changes the values of the Select depending on the option that is selected?

If we are thinking specifically about color palettes where new values and select all are disabled, maybe this should be a specific component?

If you ask me, given the complexity involved, I would implement this with a combination of radio group + Select.

[michael-s-molina]

Maybe another question would be, does it really make a difference separating color pallets by featured / others / etc? If so, another possible alternative would be to render the elements with a featured label as we do for database types.

[kgabryje]

• Selected items are always sorted first. How will that work with groups?

Good question. Currently I left it unsorted, but I was thinking about sorting the selected within the groups. The groups remain in their initial positions.

• We allow new items. Where will they be placed?

New items do not belong to any group - they will be treated as regular (ungrouped) options

• What's the interaction with Select All?

It simply selects all options

Have we considered implementing this outside of the Select component? Like a radio group that changes the values of the Select depending on the option that is selected?

If we are thinking specifically about color palettes where new values and select all are disabled, maybe this should be a specific component?

If you ask me, given the complexity involved, I would implement this with a combination of radio group + Select.

The option groups are supported by the native Antd Select, so in my opinion we should also support them in our customised Select. Right now the color scheme picker is our only use case for the groups, but I feel like grouping the options in categories is not such an uncommon thing to do and the need for it might pop up in the future

EDIT: formatting

[michael-s-molina]

The option groups are supported by the native Antd Select, so in my opinion we should also support them in our customised Select. Right now the color scheme picker is our only use case for the groups, but I feel like grouping the options in categories is not such an uncommon thing to do and the need for it might pop up in the future

We can go down that road but keep in mind that complexity will increase given the other requirements we have and that the Ant Design select does not have such as sorting selected items and new items. If we can avoid that, it would be better. That's why I'm trying to see if there's an alternative before starting to analyze how to resolve all the questions I posted above.

[michael-s-molina]

If there's no alternative, and we really need to implement this behavior, then we need to think about how to break the select component because I don't how this behavior will work with:

• Selected items are always sorted first. How will that work with groups?
• We allow new items. Where will they be placed?
• What's the interaction with Select All?

[kgabryje]

If there's no alternative, and we really need to implement this behavior, then we need to think about how to break the select component because I don't how this behavior will work with:

• Selected items are always sorted first. How will that work with groups?
• We allow new items. Where will they be placed?
• What's the interaction with Select All?

Ugh sorry, I answered those questions in my first response but messed up the formatting 🤦

Pasting it here again:

• Selected items are always sorted first. How will that work with groups?

Good question. Currently I left it unsorted, but I was thinking about sorting the selected within the groups. The groups remain in their initial positions.

• We allow new items. Where will they be placed?

New items do not belong to any group - they will be treated as regular (ungrouped) options

• What's the interaction with Select All?

It simply selects/deselects all options, like with ungrouped options

[michael-s-molina]

@kgabryje @geido Let's do a meeting to discuss this change as I'm worried about complexity increase.

[kgabryje]

/testenv up

[github-actions]

@kgabryje Ephemeral environment spinning up at http://34.222.156.36:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

[kgabryje]

@michael-s-molina @geido Following our discussion from last week, I opted for "low effort" solution for now, which is using Antd Select for ColorSchemeControl instead of our custom Select component. We'll revisit this component in the near future and try to figure out if we can provide a better user experience by rewriting this control with different UI

[michael-s-molina]

@kgabryje Did you forget to commit something? I'm still seeing some changes in the Select component such as group options.

[kgabryje]

@michael-s-molina Thanks for spotting, I updated the PR. I left the styling for groups in StyledSelect, so that the component can be reused for grouped options

[kgabryje]

/testenv up

[github-actions]

@kgabryje Ephemeral environment spinning up at http://34.216.167.224:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

[michael-s-molina]

I believe these should be moved to the ColorSchemeControl:

<StyledSelect
  css={css`
    width: 100%;
    <HERE>
  `}

[kgabryje]

👍

[michael-s-molina]

I'm not sure if these should go into the theme object. Could you add a TODO comment to revisit this file when working on SIP-82 Improving Superset Theming?

[kgabryje]

👍

[kgabryje]

Do you think all the other colour scheme files (including the old ones) should be revisited? I can add todos to all of them so that we don't miss them

[michael-s-molina]

That would be great! Thank you!

[michael-s-molina]

LGTM. Thanks for addressing the comments @kgabryje!

[kgabryje]

/testenv up

[github-actions]

@kgabryje Ephemeral environment spinning up at http://35.89.137.51:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

[github-actions]

Ephemeral environment shutdown and build artifacts deleted.