-
Notifications
You must be signed in to change notification settings - Fork 295
fix: make sidebar toggle an externally-provided component via ComponentContext #3088
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
Open
oliverlaz
wants to merge
3
commits into
master
Choose a base branch
from
fix/hide-toggle-sidebar-without-channel-list
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 was deleted.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -1,28 +1,23 @@ | ||
| import React, { type ComponentType } from 'react'; | ||
| import React from 'react'; | ||
| import clsx from 'clsx'; | ||
| import { useChatContext, useTranslationContext } from '../../context'; | ||
| import { IconSidebar } from '../Icons'; | ||
| import { ToggleSidebarButton } from '../Button/ToggleSidebarButton'; | ||
| import { | ||
| useChatContext, | ||
| useComponentContext, | ||
| useTranslationContext, | ||
| } from '../../context'; | ||
|
|
||
| export type ChannelListHeaderProps = { | ||
| ToggleButtonIcon?: ComponentType; | ||
| }; | ||
|
|
||
| export const ChannelListHeader = ({ | ||
| ToggleButtonIcon = IconSidebar, | ||
| }: ChannelListHeaderProps) => { | ||
| export const ChannelListHeader = () => { | ||
| const { t } = useTranslationContext(); | ||
| const { channel, navOpen } = useChatContext(); | ||
| const { SidebarToggle } = useComponentContext(); | ||
| return ( | ||
| <div | ||
| className={clsx('str-chat__channel-list__header', { | ||
| 'str-chat__channel-list__header--sidebar-collapsed': !navOpen, | ||
| })} | ||
| > | ||
| <div className='str-chat__channel-list__header__title'>{t('Chats')}</div> | ||
| <ToggleSidebarButton canCollapse={!!channel} mode={'collapse'}> | ||
| <ToggleButtonIcon /> | ||
| </ToggleSidebarButton> | ||
| {channel && SidebarToggle && <SidebarToggle />} | ||
| </div> | ||
| ); | ||
| }; |
53 changes: 53 additions & 0 deletions
53
src/components/ChannelList/__tests__/ChannelListHeader.test.tsx
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,53 @@ | ||
| import React from 'react'; | ||
| import { cleanup, render, screen } from '@testing-library/react'; | ||
| import { ChatProvider, WithComponents } from '../../../context'; | ||
| import { TranslationProvider } from '../../../context/TranslationContext'; | ||
| import { mockChatContext, mockTranslationContextValue } from '../../../mock-builders'; | ||
| import { ChannelListHeader } from '../ChannelListHeader'; | ||
|
|
||
| const t = vi.fn((key: string) => key); | ||
| const SidebarToggle = () => <div data-testid='sidebar-toggle' />; | ||
|
|
||
| afterEach(cleanup); | ||
|
|
||
| describe('ChannelListHeader', () => { | ||
| it('should not render SidebarToggle when not provided via ComponentContext', () => { | ||
| render( | ||
| <ChatProvider value={mockChatContext()}> | ||
| <TranslationProvider value={mockTranslationContextValue({ t })}> | ||
| <ChannelListHeader /> | ||
| </TranslationProvider> | ||
| </ChatProvider>, | ||
| ); | ||
|
|
||
| expect(screen.queryByTestId('sidebar-toggle')).not.toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('should render SidebarToggle when a channel is active', () => { | ||
| render( | ||
| <WithComponents overrides={{ SidebarToggle }}> | ||
| <ChatProvider value={mockChatContext({ channel: {} })}> | ||
| <TranslationProvider value={mockTranslationContextValue({ t })}> | ||
| <ChannelListHeader /> | ||
| </TranslationProvider> | ||
| </ChatProvider> | ||
| </WithComponents>, | ||
| ); | ||
|
|
||
| expect(screen.getByTestId('sidebar-toggle')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| it('should not render SidebarToggle when no channel is active', () => { | ||
| render( | ||
| <WithComponents overrides={{ SidebarToggle }}> | ||
| <ChatProvider value={mockChatContext({ channel: undefined })}> | ||
| <TranslationProvider value={mockTranslationContextValue({ t })}> | ||
| <ChannelListHeader /> | ||
| </TranslationProvider> | ||
| </ChatProvider> | ||
| </WithComponents>, | ||
| ); | ||
|
|
||
| expect(screen.queryByTestId('sidebar-toggle')).not.toBeInTheDocument(); | ||
| }); | ||
| }); |
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
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.
@oliverlaz
navOpenstate is used in many places to coordinate the channel list / thread list display, so not sure we can remove it. On the other hand we need to make sure we document how sidebar display should be handled in the docs probably - some cookbook. WDYT?