-
Notifications
You must be signed in to change notification settings - Fork 682
Port EventList to React #5727
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
Merged
Merged
Port EventList to React #5727
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
094a144
Add EventList component
gettinToasty c065789
Add animation and fontFamily metadata
gettinToasty 222d8dc
Add infra
gettinToasty d4378a1
Fix rendering error
gettinToasty 62fa184
Remove deprecated services
gettinToasty 571232f
Merge branch 'master' into sb_port_event_list
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,219 @@ | ||
| import React from 'react'; | ||
| import { Menu } from 'antd'; | ||
| import { IWidgetCommonState, useWidget, WidgetModule } from './common/useWidget'; | ||
| import { WidgetLayout } from './common/WidgetLayout'; | ||
| import { $t } from '../../services/i18n'; | ||
| import { metadata } from '../shared/inputs/metadata'; | ||
| import FormFactory from 'components-react/shared/inputs/FormFactory'; | ||
| import { UserService } from 'app-services'; | ||
| import { Services } from 'components-react/service-provider'; | ||
| import { TPlatform } from 'services/platforms'; | ||
| import Form from 'components-react/shared/inputs/Form'; | ||
|
|
||
| interface IEventListState extends IWidgetCommonState { | ||
| data: { | ||
| themes: Dictionary<{ label: string }>; | ||
| settings: { | ||
| animation_speed: number; | ||
| background_color: string; | ||
| bits_minimum: number; | ||
| brightness: number; | ||
| fade_time: number; | ||
| flip_x: boolean; | ||
| flip_y: boolean; | ||
| font_family: string; | ||
| hide_animation: string; | ||
| hue: number; | ||
| keep_history: boolean; | ||
| max_events: number; | ||
| raid_raider_minimum: number; | ||
| saturation: number; | ||
| show_animation: string; | ||
| show_bits: boolean; | ||
| show_donations: boolean; | ||
| show_eldonations: boolean; | ||
| show_follows: boolean; | ||
| show_gamewispresubscriptions: boolean; | ||
| show_gamewispsubscriptions: boolean; | ||
| show_justgivingdonations: boolean; | ||
| show_merch: boolean; | ||
| show_pledges: boolean; | ||
| show_raids: boolean; | ||
| show_redemptions: boolean; | ||
| show_resubs: boolean; | ||
| show_smfredemptions: boolean; | ||
| show_sub_tiers: boolean; | ||
| show_subscriptions: boolean; | ||
| show_subscribers: boolean; | ||
| show_tiltifydonations: boolean; | ||
| show_treats: boolean; | ||
| text_color: string; | ||
| text_size: number; | ||
| theme: string; | ||
| theme_color: string; | ||
| }; | ||
| }; | ||
| } | ||
|
|
||
| export function EventList() { | ||
| const { | ||
| isLoading, | ||
| settings, | ||
| eventMeta, | ||
| fontMeta, | ||
| visualMeta, | ||
| updateSetting, | ||
| setSelectedTab, | ||
| selectedTab, | ||
| } = useEventList(); | ||
|
|
||
| // use 1 column layout | ||
| return ( | ||
| <WidgetLayout> | ||
| <Menu onClick={e => setSelectedTab(e.key)} selectedKeys={[selectedTab]}> | ||
| <Menu.Item key="event">{$t('Manage List')}</Menu.Item> | ||
| <Menu.Item key="font">{$t('Font Settings')}</Menu.Item> | ||
| <Menu.Item key="visual">{$t('Visual Settings')}</Menu.Item> | ||
| </Menu> | ||
| <Form> | ||
| {!isLoading && selectedTab === 'event' && ( | ||
| <FormFactory metadata={eventMeta} values={settings} onChange={updateSetting} /> | ||
| )} | ||
| {!isLoading && selectedTab === 'font' && ( | ||
| <FormFactory metadata={fontMeta} values={settings} onChange={updateSetting} /> | ||
| )} | ||
| {!isLoading && selectedTab === 'visual' && ( | ||
| <FormFactory metadata={visualMeta} values={settings} onChange={updateSetting} /> | ||
| )} | ||
| </Form> | ||
| </WidgetLayout> | ||
| ); | ||
| } | ||
|
|
||
| export class EventListModule extends WidgetModule<IEventListState> { | ||
| get UserService() { | ||
| return Services.UserService; | ||
| } | ||
|
|
||
| get eventsByPlatform() { | ||
| const platform = this.UserService.views.platform?.type; | ||
| const baseEvents = { | ||
| show_donations: metadata.bool({ label: $t('Donations') }), | ||
| show_merch: metadata.bool({ label: $t('Merch') }), | ||
| }; | ||
| const platformEvents: PartialRec<TPlatform, any> = { | ||
| twitch: { | ||
| show_follows: metadata.bool({ label: $t('Follows') }), | ||
| show_subscriptions: metadata.bool({ label: $t('Subscriptions') }), | ||
| show_resubs: metadata.bool({ label: $t('Show Resubs') }), | ||
| show_sub_tiers: metadata.bool({ label: $t('Show Sub Tiers') }), | ||
| show_bits: metadata.bool({ label: $t('Bits') }), | ||
| show_raids: metadata.bool({ label: $t('Raids') }), | ||
| }, | ||
| facebook: { | ||
| show_follows: metadata.bool({ label: $t('Follows') }), | ||
| show_stars: metadata.bool({ label: $t('Stars') }), | ||
| show_supports: metadata.bool({ label: $t('Supporters') }), | ||
| show_likes: metadata.bool({ label: $t('Likes') }), | ||
| show_shares: metadata.bool({ label: $t('Shares') }), | ||
| }, | ||
| youtube: { | ||
| show_subscribers: metadata.bool({ label: $t('Subscriptions') }), | ||
| show_sponsors: metadata.bool({ label: $t('Members') }), | ||
| show_fanfundings: metadata.bool({ label: $t('Super Chats') }), | ||
| }, | ||
| trovo: { | ||
| show_follows: metadata.bool({ label: $t('Follows') }), | ||
| show_raids: metadata.bool({ label: $t('Raids') }), | ||
| show_subscriptions: metadata.bool({ label: $t('Subscriptions') }), | ||
| show_resubs: metadata.bool({ label: $t('Show Resubs') }), | ||
| show_sub_gifts: metadata.bool({ label: $t('Show Gift Subs') }), | ||
| show_sub_tiers: metadata.bool({ label: $t('Show Sub Tiers') }), | ||
| }, | ||
| }; | ||
| if (!platform) return baseEvents; | ||
| return { ...platformEvents[platform], ...baseEvents }; | ||
| } | ||
|
|
||
| get eventMeta() { | ||
| return { | ||
| enabled: { | ||
| type: 'checkboxGroup', | ||
| label: $t('Enable Events'), | ||
| children: this.eventsByPlatform, | ||
| }, | ||
| max_events: metadata.slider({ | ||
| label: $t('Max Events'), | ||
| max: 10, | ||
| step: 1, | ||
| children: { | ||
| bits_minimum: metadata.number({ | ||
| displayed: this.UserService.views.platform?.type === 'twitch', | ||
| label: $t('Min. Bits'), | ||
| tooltip: $t( | ||
| 'The smallest amount of bits a cheer must have for an event to be shown. Setting this to 0 will make every cheer trigger an event.', | ||
| ), | ||
| }), | ||
| }, | ||
| }), | ||
| }; | ||
| } | ||
|
|
||
| get fontMeta() { | ||
| return { | ||
| text_color: metadata.color({ | ||
| label: $t('Text Color'), | ||
| tooltip: $t('A hex code for the base text color.'), | ||
| }), | ||
| font_family: metadata.fontFamily({ label: $t('Font') }), | ||
| text_size: metadata.fontSize({ | ||
| label: $t('Font Size'), | ||
| min: 10, | ||
| max: 80, | ||
| tooltip: $t( | ||
| 'The font size in pixels. Reasonable size typically ranges between 24px and 48px.', | ||
| ), | ||
| }), | ||
| }; | ||
| } | ||
|
|
||
| get visualMeta() { | ||
| return { | ||
| theme: metadata.list({ | ||
| label: $t('Theme'), | ||
| options: Object.entries(this.widgetData?.themes || []).map(([theme, val]) => ({ | ||
| label: val.label, | ||
| value: theme, | ||
| })), | ||
| }), | ||
| background_color: metadata.color({ | ||
| label: $t('Background Color'), | ||
| tooltip: $t( | ||
| 'A hex code for the widget background. This is for preview purposes only. It will not be shown in your stream.', | ||
| ), | ||
| }), | ||
| show_animation: metadata.animation({ label: $t('Show Animation'), filter: 'eventIn' }), | ||
| hide_animation: metadata.animation({ label: $t('Hide Animation'), filter: 'eventOut' }), | ||
| animation_speed: metadata.slider({ | ||
| label: $t('Animation Speed'), | ||
| min: 250, | ||
| max: 4000, | ||
| step: 250, | ||
| }), | ||
| fade_time: metadata.slider({ label: $t('Fade Time'), max: 60, step: 1 }), | ||
| other: { | ||
| type: 'checkboxGroup', | ||
| label: $t('Other Options'), | ||
| children: { | ||
| flip_x: metadata.bool({ label: $t('Flip X') }), | ||
| flip_y: metadata.bool({ label: $t('Flip Y') }), | ||
| keep_history: metadata.bool({ label: $t('Keep Events History') }), | ||
| }, | ||
| }, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| function useEventList() { | ||
| return useWidget<EventListModule>(); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moving this from a map to a switch saves loading all the loc strings for the unused platforms:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
while true it's not an expensive operation and i think the object notation looks a little cleaner, just a personal preference