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

Rework Settings gui (SOFIE-2300) #922

Draft
wants to merge 10 commits into
base: release51
Choose a base branch
from
Draft

Conversation

nytamin
Copy link
Contributor

@nytamin nytamin commented May 12, 2023

Work in progress

This PR aims at change how the settings pages are made, in order to provide several quality-of-life issues, such as:

  • A unified “filterable” settings tree component that we could reuse.
  • Use VS Code Settings page as a reference
  • Have the settings be divided into nested sections.
  • Lists should be sortable
  • Have an auto-focused “Search settings” text box

@nytamin nytamin changed the base branch from master to release50 May 12, 2023 07:02
@codecov-commenter
Copy link

codecov-commenter commented May 12, 2023

Codecov Report

Patch coverage: 3.50% and project coverage change: -1.62 ⚠️

Comparison is base (f291c9a) 57.09% compared to head (fc850ec) 55.47%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@              Coverage Diff              @@
##           release50     #922      +/-   ##
=============================================
- Coverage      57.09%   55.47%   -1.62%     
=============================================
  Files            481      493      +12     
  Lines          76054    79050    +2996     
  Branches        3771     3832      +61     
=============================================
+ Hits           43421    43855     +434     
- Misses         32582    35144    +2562     
  Partials          51       51              
Impacted Files Coverage Δ
meteor/client/lib/guiSettings/guiSettings.ts 0.00% <0.00%> (ø)
.../lib/guiSettings/studioSettings/blueprint/index.ts 0.00% <0.00%> (ø)
meteor/lib/lib.ts 79.19% <9.09%> (-0.53%) ⬇️
meteor/server/collections/collection.ts 98.23% <100.00%> (+0.03%) ⬆️

... and 23 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

type: GUISettingsType.SETTING,
name: t('Compatible Show Styles'),
description: t('Which Show Styles are compatible with this studio'),
id: `${urlBase}/blueprint`,
Copy link
Member

Choose a reason for hiding this comment

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

It would be really good if these ID's were autogenerated somehow? I think these will be very easy to get mixed up.

Comment on lines 157 to 165
type: GUISettingsType.SETTING,
name: t('Enable "Play from Anywhere"'),
description: t('When enabled, the "play from anywhere" option is available to the users in rundown-GUI'),
id: `${urlBase}/settings.enablePlayFromAnywhere`,
// getWarning: () => undefined,
render: () => {
return <EditAttribute {...editAttributeProps} type="checkbox" attribute="settings.enablePlayFromAnywhere" />
},
getSearchString: '',
Copy link
Member

@jstarpl jstarpl May 15, 2023

Choose a reason for hiding this comment

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

These are very repetitive for a lot of these items. Should type: GUISettingsType.SETTING be implied, if not specified? Can the render function have a default implementation that can be overloaded, if needed?

options={availableShowStyleBases}
label={t('Click to show available Show Styles')}
/>
{renderShowStyleEditButtons(studio, availableShowStyleBases)}
Copy link
Member

Choose a reason for hiding this comment

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

I think this could easily be a JSX component.

@jstarpl jstarpl changed the base branch from release50 to release51 September 27, 2023 11:26
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.

None yet

3 participants