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

feat(side-panel): add SidePanelFooter #4002

Merged
merged 9 commits into from
Jul 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/new-fans-call.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@twilio-paste/ai-chat-log": patch
"@twilio-paste/core": patch
---

[AI Chat Log] Remove padding-x on AI Chat Log to prevent double padding when log is used within a Side Panel container.
6 changes: 6 additions & 0 deletions .changeset/nine-geese-end.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@twilio-paste/chat-composer": patch
"@twilio-paste/core": patch
---

[Chat Composer] Add width="100%" to ChatComposerContainer to prevent composer from shrinking when no value
6 changes: 6 additions & 0 deletions .changeset/real-flowers-turn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@twilio-paste/side-modal": patch
"@twilio-paste/core": patch
---

[Side Modal] Increase size of close icon.
5 changes: 5 additions & 0 deletions .changeset/tasty-rats-sniff.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@twilio-paste/codemods": patch
---

[Codemods] New export from side-panel package
6 changes: 6 additions & 0 deletions .changeset/tiny-badgers-rush.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@twilio-paste/side-panel": minor
"@twilio-paste/core": minor
---

[Side Panel] Create SidePanelFooter exported from the Side Panel package for actions or chat composers. Make scrollbar color of SidePanelBody slightly darker for better visibility. Small improvements to spacing and alignment of SidePanelHeader.
1 change: 1 addition & 0 deletions packages/paste-codemods/tools/.cache/mappings.json
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@
"SidePanelButton": "@twilio-paste/core/side-panel",
"SidePanelContainer": "@twilio-paste/core/side-panel",
"SidePanelContext": "@twilio-paste/core/side-panel",
"SidePanelFooter": "@twilio-paste/core/side-panel",
"SidePanelHeader": "@twilio-paste/core/side-panel",
"SidePanelHeaderActions": "@twilio-paste/core/side-panel",
"SidePanelPushContentWrapper": "@twilio-paste/core/side-panel",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export interface AIChatLogProps extends HTMLPasteProps<"div"> {
export const AIChatLog = React.forwardRef<HTMLDivElement, AIChatLogProps>(
({ element = "AI_CHAT_LOG", children, ...props }, ref) => {
return (
<Box role="log" padding="space70" element={element} ref={ref} {...safelySpreadBoxProps(props)}>
<Box role="log" paddingY="space70" element={element} ref={ref} {...safelySpreadBoxProps(props)}>
<Box
as="div"
role="list"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,23 +84,6 @@ const createNewMessage = (message: string): Omit<AIChat, "id"> => {
};
};

const SendButtonPlugin = ({ onClick }: { onClick: () => void }): JSX.Element => {
const [editor] = useLexicalComposerContext();

const handleSend = (): void => {
onClick();
editor.dispatchCommand(CLEAR_EDITOR_COMMAND, undefined);
};

return (
<Box position="absolute" top="space30" right="space30">
<Button variant="primary_icon" size="reset" onClick={handleSend}>
<SendIcon decorative={false} title="Send message" />
</Button>
</Box>
);
};

const EnterKeySubmitPlugin = ({ onKeyDown }: { onKeyDown: () => void }): null => {
const [editor] = useLexicalComposerContext();

Expand Down Expand Up @@ -203,7 +186,7 @@ export const AIChatLogComposer = (): React.ReactNode => {

return (
<Box>
<Box ref={scrollerRef} overflowX="hidden" overflowY="auto" maxHeight="size50" tabIndex={0}>
<Box ref={scrollerRef} overflowX="hidden" overflowY="auto" maxHeight="size50" padding="space50" tabIndex={0}>
<AIChatLogger ref={loggerRef} aiChats={aiChats} />
</Box>
<ChatComposerContainer variant="contained">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ export const ChatComposerContainer = React.forwardRef<HTMLDivElement, ChatCompos
maxHeight={maxHeight}
overflowY="auto"
rowGap="space50"
width="100%"
{...Styles[variant]}
>
{children}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,13 @@ const SideModalHeader = React.forwardRef<HTMLDivElement, SideModalHeaderProps>(
element={element}
display="flex"
flexDirection="row"
alignItems="flex-start"
>
<Box display="flex" flexGrow={1} marginRight="space70" alignItems="center">
<Box display="flex" flexGrow={1} marginRight="space70">
{children}
</Box>
<Button element={`${element}_CLOSE_BUTTON`} variant="secondary_icon" size="reset" onClick={hide}>
<CloseIcon element={`${element}_CLOSE_ICON`} decorative size="sizeIcon20" />
<CloseIcon element={`${element}_CLOSE_ICON`} decorative size="sizeIcon50" />
<ScreenReaderOnly>{i18nDismissLabel}</ScreenReaderOnly>
</Button>
</Box>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { SidePanelBodyProps } from "./types";

// This wrapper applies styles that customize the scrollbar and its track
const SidePanelBodyWrapper = styled.div(({ theme }: { theme: ThemeShape }) => {
const { colorBackgroundBody, colorBackground, colorBackgroundStrong } = theme.backgroundColors;
const { colorBackgroundBody, colorBackgroundStrong, colorBackgroundStronger } = theme.backgroundColors;

return css({
// Scrollbar
Expand All @@ -17,17 +17,18 @@ const SidePanelBodyWrapper = styled.div(({ theme }: { theme: ThemeShape }) => {
// Track
"::-webkit-scrollbar-track": {
marginTop: "8px",
marginBottom: "8px",
background: colorBackgroundBody,
borderRadius: "10px",
},
// Handle
"::-webkit-scrollbar-thumb": {
background: colorBackground,
background: colorBackgroundStrong,
borderRadius: "10px",
},
// Handle on hover
"::-webkit-scrollbar-thumb:hover": {
background: colorBackgroundStrong,
background: colorBackgroundStronger,
},
});
});
Expand Down
34 changes: 34 additions & 0 deletions packages/paste-core/components/side-panel/src/SidePanelFooter.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { Box, safelySpreadBoxProps } from "@twilio-paste/box";
import * as React from "react";

import type { SidePanelFooterProps } from "./types";

const SidePanelFooter = React.forwardRef<HTMLDivElement, SidePanelFooterProps>(
({ element = "SIDE_PANEL_FOOTER", variant = "default", children, justifyContent = "flex-start", ...props }, ref) => {
return (
<Box
width="100%"
paddingX={variant === "chat" ? "space50" : "space70"}
paddingBottom="space50"
paddingTop={variant === "chat" ? "space0" : "space50"}
boxShadow={variant === "chat" ? "none" : "shadow"}
marginBottom="spaceNegative70"
zIndex="zIndex20"
display="flex"
columnGap="space40"
rowGap="space40"
justifyContent={justifyContent}
flexWrap="wrap"
{...safelySpreadBoxProps(props)}
ref={ref}
element={element}
>
{children}
</Box>
);
},
);

SidePanelFooter.displayName = "SidePanelFooter";

export { SidePanelFooter };
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ const SidePanelHeader = React.forwardRef<HTMLDivElement, SidePanelHeaderProps>(
padding="space70"
display="flex"
columnGap="space30"
alignItems="center"
alignItems="flex-start"
justifyContent="space-between"
{...safelySpreadBoxProps(props)}
ref={ref}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const SidePanelHeaderActions = React.forwardRef<HTMLDivElement, SidePanelHeaderA
({ element = "SIDE_PANEL_HEADER_ACTIONS", children, ...props }, ref) => {
return (
<Box
width="100%"
flexGrow={1}
display="flex"
justifyContent="flex-end"
columnGap="space20"
Expand Down
2 changes: 2 additions & 0 deletions packages/paste-core/components/side-panel/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export { SidePanelBody } from "./SidePanelBody";
export { SidePanelContainer } from "./SidePanelContainer";
export { SidePanelButton } from "./SidePanelButton";
export { SidePanelBadgeButton } from "./SidePanelBadgeButton";
export { SidePanelFooter } from "./SidePanelFooter";
export type {
SidePanelButtonProps,
SidePanelBadgeButtonProps,
Expand All @@ -15,5 +16,6 @@ export type {
SidePanelHeaderActionsProps,
SidePanelContainerProps,
SidePanelBodyProps,
SidePanelFooterProps,
} from "./types";
export { SidePanelContext } from "./SidePanelContext";
25 changes: 25 additions & 0 deletions packages/paste-core/components/side-panel/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,31 @@ export interface SidePanelHeaderProps extends HTMLPasteProps<"div"> {
element?: BoxProps["element"];
}

export interface SidePanelFooterProps extends HTMLPasteProps<"div"> {
children?: React.ReactNode;
/**
* Variant of the Side Panel Footer. When using Side Panel in an AI Chat context, use the "chat" variant to wrap the Chat Composer component.
* @default "default"
* @type {"default" | "chat"}
* @memberof SidePanelFooterProps
*/
variant?: "default" | "chat";
/**
* Sets the `justify-content` CSS property.
* @default "flex-start"
* @type {"flex-start" | "flex-end" | "space-between"}
* @memberof SidePanelFooterProps
*/
Comment on lines +54 to +60
Copy link
Collaborator

Choose a reason for hiding this comment

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

👏

justifyContent?: "flex-start" | "flex-end" | "space-between";
/**
* Overrides the default element name to apply unique styles with the Customization Provider
* @default "SIDE_PANEL_FOOTER"
* @type {BoxProps['element']}
* @memberof SidePanelFooterProps
*/
element?: BoxProps["element"];
}

export interface SidePanelHeaderActionsProps extends HTMLPasteProps<"div"> {
children?: React.ReactNode;
/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
// eslint-disable-next-line eslint-comments/disable-enable-pair
/* eslint-disable import/no-extraneous-dependencies */
import { AIChatLog, AIChatMessage, AIChatMessageAuthor, AIChatMessageBody } from "@twilio-paste/ai-chat-log";
import { Anchor } from "@twilio-paste/anchor";
import { Box } from "@twilio-paste/box";
import { Button } from "@twilio-paste/button";
import { ChatComposer, ChatComposerActionGroup, ChatComposerContainer } from "@twilio-paste/chat-composer";
import { Heading } from "@twilio-paste/heading";
import { ArtificialIntelligenceIcon } from "@twilio-paste/icons/esm/ArtificialIntelligenceIcon";
import { AttachIcon } from "@twilio-paste/icons/esm/AttachIcon";
import { MoreIcon } from "@twilio-paste/icons/esm/MoreIcon";
import { SendIcon } from "@twilio-paste/icons/esm/SendIcon";
import { Separator } from "@twilio-paste/separator";
import * as React from "react";

import { SidePanel, SidePanelBody, SidePanelFooter, SidePanelHeader, SidePanelHeaderActions } from "../../src";

export const SidePanelWithAIContent: React.FC<React.PropsWithChildren> = () => {
return (
<SidePanel label="intelligent assistant ai bot side panel">
<SidePanelHeader>
<ArtificialIntelligenceIcon decorative size="sizeIcon50" color="colorTextIcon" />
<Heading as="h3" variant="heading30" marginBottom="space0">
Assistant
</Heading>
<SidePanelHeaderActions>
<Button variant="secondary_icon" size="reset" onClick={() => {}}>
<MoreIcon decorative={false} title="open menu" size="sizeIcon50" />
</Button>
</SidePanelHeaderActions>
</SidePanelHeader>
<Separator orientation="horizontal" verticalSpacing="space0" />
<SidePanelBody>
<Box width="100%">
<AIChatLog>
<AIChatMessage variant="bot">
<AIChatMessageAuthor aria-label="ai said">Good Bot</AIChatMessageAuthor>
<AIChatMessageBody>Hello, what can I help you with?</AIChatMessageBody>
</AIChatMessage>
<AIChatMessage variant="user">
<AIChatMessageAuthor aria-label="You said at 2:36pm">Gibby Radki</AIChatMessageAuthor>
<AIChatMessageBody>Hi! Can you help me with my user interface?</AIChatMessageBody>
</AIChatMessage>
<AIChatMessage variant="bot">
<AIChatMessageAuthor aria-label="ai said">Good Bot</AIChatMessageAuthor>
Of course! What do you need help with?
</AIChatMessage>
<AIChatMessage variant="bot">
<AIChatMessageAuthor aria-label="ai said">Good Bot</AIChatMessageAuthor>
<AIChatMessageBody>
I&apos;m happy to help with any questions you have about user interfaces, accessibility, or the Twilio
Paste design system. Just ask!
</AIChatMessageBody>
</AIChatMessage>
<AIChatMessage variant="user">
<AIChatMessageAuthor aria-label="You said at 2:39pm">Gibby Radki</AIChatMessageAuthor>
<AIChatMessageBody>My question is about the Switch component.</AIChatMessageBody>
</AIChatMessage>
<AIChatMessage variant="bot">
<AIChatMessageAuthor aria-label="ai said">Good Bot</AIChatMessageAuthor>
<AIChatMessageBody>
A <Anchor href="https://paste.twilio.design/components/switch">Switch</Anchor> is an interactive binary
control. What other information about the Paste Switch component can I help with?
</AIChatMessageBody>
</AIChatMessage>
</AIChatLog>
</Box>
</SidePanelBody>
<SidePanelFooter variant="chat">
<ChatComposerContainer variant="contained">
<ChatComposer
maxHeight="size10"
config={{
namespace: "customer-chat",
onError: (e) => {
throw e;
},
}}
initialValue="Are switch labels required? What about "
placeholder="Chat text"
ariaLabel="A basic chat composer"
/>
<ChatComposerActionGroup>
<Button variant="secondary_icon" size="reset">
<AttachIcon decorative={false} title="attach files to the message" />
</Button>
<Button variant="primary_icon" size="reset">
<SendIcon decorative={false} title="Send" />
</Button>
</ChatComposerActionGroup>
</ChatComposerContainer>
</SidePanelFooter>
</SidePanel>
);
};
Loading
Loading