@maanlamp/react-web-ui 0.0.0-stage → 0.1.1

package/dist/components/conversation/conversation.d.ts

@@ -0,0 +1,127 @@
+import { useRender } from "@base-ui/react/use-render";
+import type { ComponentProps, ReactElement, ReactNode } from "react";
+import { type ConversationMessageSide, type ConversationMessageStatus } from "./conversation.context.ts";
+import { type ConversationMoment } from "./moment.ts";
+export type ConversationRootProps = useRender.ComponentProps<"div">;
+/**
+ * A conversation's message log: a polite live region that announces new
+ * messages, holding day groups of messages.
+ */
+declare const Root: ({ className, render, ...props }: ConversationRootProps) => ReactElement;
+export type ConversationGroupProps = useRender.ComponentProps<"section">;
+/** One day's messages, under its `DateSeparator`. */
+declare const Group: ({ className, render, ...props }: ConversationGroupProps) => ReactElement;
+export type ConversationGroupSeparatorProps = useRender.ComponentProps<"div">;
+/** A pill heading a group that sticks to the top while its group scrolls by. */
+declare const GroupSeparator: ({ className, render, ...props }: ConversationGroupSeparatorProps) => ReactElement;
+export type ConversationDateSeparatorProps = Readonly<{
+    date: ConversationMoment;
+    /** What the separator says for today's messages, such as "Today". */
+    todayLabel: string;
+    /** What the separator says for yesterday's messages, such as "Yesterday". */
+    yesterdayLabel: string;
+}> & Omit<ConversationGroupSeparatorProps, "children">;
+/**
+ * A `GroupSeparator` naming the day of `date` in the provider's time zone:
+ * `todayLabel`, `yesterdayLabel`, or the long date.
+ */
+declare const DateSeparator: ({ date, todayLabel, yesterdayLabel, ...props }: ConversationDateSeparatorProps) => ReactNode;
+export type ConversationMessageProps = Readonly<{
+    side: ConversationMessageSide;
+}> & useRender.ComponentProps<"div">;
+/** A burst of messages from one author, aligned to its `side`. */
+declare const Message: ({ side, className, render, ...props }: ConversationMessageProps) => ReactNode;
+export type ConversationMessageBubbleProps = useRender.ComponentProps<"div">;
+/** One message's bubble, pointed toward its author. */
+declare const MessageBubble: ({ className, render, ...props }: ConversationMessageBubbleProps) => ReactElement;
+export type ConversationMessageAuthorProps = Readonly<{
+    /** Aligns an author line rendered outside a `Message`. */
+    side?: ConversationMessageSide;
+}> & useRender.ComponentProps<"div">;
+/** The line above a burst: avatar, name, timestamp and read status. */
+declare const MessageAuthor: ({ side, className, render, ...props }: ConversationMessageAuthorProps) => ReactElement;
+export type ConversationMessageAvatarProps = Readonly<{
+    /** Display name; drives the initials and stable tone of the avatar. */
+    name: string;
+    /** Diameter relative to the surrounding font size (in `em`). @default 1.5 */
+    size?: number;
+}>;
+/** The author's `Avatar`, sized for the author line. */
+declare const MessageAvatar: ({ name, size, }: ConversationMessageAvatarProps) => ReactNode;
+export type ConversationMessageTimestampProps = Readonly<{
+    date: ConversationMoment;
+    /** Shows the date as well as the time. @default false */
+    withDate?: boolean;
+}> & Omit<useRender.ComponentProps<"time">, "children" | "dateTime">;
+/** When a message was sent, in the provider's locale and time zone. */
+declare const MessageTimestamp: ({ date, withDate, className, render, ...props }: ConversationMessageTimestampProps) => ReactElement;
+export type ConversationMessageReadIndicatorProps = Readonly<{
+    status: ConversationMessageStatus;
+    /** What the status is announced as, such as "Read" or "Unread". */
+    label: string;
+    /** Replaces the dot shown for the status. */
+    children?: ReactNode;
+}> & Omit<ComponentProps<"div">, "children">;
+/** Whether the other party has read the message: a dot, and its `label` for assistive tech. */
+declare const MessageReadIndicator: ({ status, label, className, children, ...props }: ConversationMessageReadIndicatorProps) => ReactNode;
+export type ConversationMessageContentProps = Readonly<{
+    /** Cuts the text off after this many lines. */
+    lineClamp?: number;
+}> & useRender.ComponentProps<"div">;
+/** A message's text, wrapped anywhere and kept as typed. */
+declare const MessageContent: ({ lineClamp, className, render, style: inlineStyle, ...props }: ConversationMessageContentProps) => ReactElement;
+export type ConversationMessageFilesProps = useRender.ComponentProps<"div">;
+/** The files sent with a message, as a wrapping row of tiles. */
+declare const MessageFiles: ({ className, render, ...props }: ConversationMessageFilesProps) => ReactElement;
+export type ConversationMessageFilesDownloadAllProps = Readonly<{
+    /** The button's accessible name and tooltip, such as "Download all files". */
+    label: string;
+}> & Omit<useRender.ComponentProps<"button">, "children">;
+/** An icon button that downloads every file of a message. */
+declare const MessageFilesDownloadAll: ({ label, render, ...props }: ConversationMessageFilesDownloadAllProps) => ReactElement;
+export type ConversationScrollToBottomProps = Readonly<{
+    /** The button's accessible name and tooltip, such as "Scroll to latest". */
+    label: string;
+}> & Omit<useRender.ComponentProps<"button">, "children">;
+/** An icon button, pinned to the log's bottom corner, that jumps to the latest message. */
+declare const ScrollToBottom: ({ label, className, render, ...props }: ConversationScrollToBottomProps) => ReactElement;
+export type ConversationEmptyStateProps = useRender.ComponentProps<"div">;
+/** What the log shows before there are any messages. */
+declare const EmptyState: ({ className, render, ...props }: ConversationEmptyStateProps) => ReactElement;
+type ConversationNamespace = Readonly<{
+    Root: typeof Root;
+    EmptyState: typeof EmptyState;
+    Group: typeof Group;
+    GroupSeparator: typeof GroupSeparator;
+    DateSeparator: typeof DateSeparator;
+    Message: typeof Message;
+    MessageBubble: typeof MessageBubble;
+    MessageAuthor: typeof MessageAuthor;
+    MessageAvatar: typeof MessageAvatar;
+    MessageTimestamp: typeof MessageTimestamp;
+    MessageReadIndicator: typeof MessageReadIndicator;
+    MessageContent: typeof MessageContent;
+    MessageFiles: typeof MessageFiles;
+    MessageFilesDownloadAll: typeof MessageFilesDownloadAll;
+    ScrollToBottom: typeof ScrollToBottom;
+}>;
+/**
+ * A message thread: a log of day groups, each a run of author bursts with their
+ * bubbles, timestamps, read status and files. Group the messages with
+ * `groupByDay` and `groupByBurst`.
+ *
+ * @example
+ * <Conversation.Root>
+ * 	<Conversation.Group>
+ * 		<Conversation.DateSeparator date={day.date} todayLabel="Today" yesterdayLabel="Yesterday" />
+ * 		<Conversation.Message side="own">
+ * 			<Conversation.MessageBubble>
+ * 				<Conversation.MessageContent>{body}</Conversation.MessageContent>
+ * 			</Conversation.MessageBubble>
+ * 		</Conversation.Message>
+ * 	</Conversation.Group>
+ * </Conversation.Root>
+ */
+export declare const Conversation: ConversationNamespace;
+export {};
+//# sourceMappingURL=conversation.d.ts.map

package/dist/components/conversation/conversation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["../../../src/components/conversation/conversation.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAItD,OAAO,KAAK,EACX,cAAc,EACd,YAAY,EACZ,SAAS,EACT,MAAM,OAAO,CAAC;AASf,OAAO,EAEN,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACN,KAAK,kBAAkB,EAEvB,MAAM,aAAa,CAAC;AAIrB,MAAM,MAAM,qBAAqB,GAChC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC;;;GAGG;AACH,QAAA,MAAM,IAAI,oCAIP,qBAAqB,KAAG,YAYxB,CAAC;AAEJ,MAAM,MAAM,sBAAsB,GACjC,SAAS,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;AAErC,qDAAqD;AACrD,QAAA,MAAM,KAAK,oCAIR,sBAAsB,KAAG,YAQzB,CAAC;AAEJ,MAAM,MAAM,+BAA+B,GAC1C,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC,gFAAgF;AAChF,QAAA,MAAM,cAAc,oCAIjB,+BAA+B,KAAG,YAQlC,CAAC;AAEJ,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CAAC;IACrD,IAAI,EAAE,kBAAkB,CAAC;IACzB,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,cAAc,EAAE,MAAM,CAAC;CACvB,CAAC,GACD,IAAI,CAAC,+BAA+B,EAAE,UAAU,CAAC,CAAC;AAEnD;;;GAGG;AACH,QAAA,MAAM,aAAa,mDAKhB,8BAA8B,KAAG,SAyBnC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;IAC/C,IAAI,EAAE,uBAAuB,CAAC;CAC9B,CAAC,GACD,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC,kEAAkE;AAClE,QAAA,MAAM,OAAO,0CAKV,wBAAwB,KAAG,SAgB7B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACzC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC,uDAAuD;AACvD,QAAA,MAAM,aAAa,oCAIhB,8BAA8B,KAAG,YAQjC,CAAC;AAEJ,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CAAC;IACrD,0DAA0D;IAC1D,IAAI,CAAC,EAAE,uBAAuB,CAAC;CAC/B,CAAC,GACD,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC,uEAAuE;AACvE,QAAA,MAAM,aAAa,0CAKhB,8BAA8B,KAAG,YASjC,CAAC;AAEJ,MAAM,MAAM,8BAA8B,GAAG,QAAQ,CAAC;IACrD,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC,CAAC;AAEH,wDAAwD;AACxD,QAAA,MAAM,aAAa,oBAGhB,8BAA8B,KAAG,SAMnC,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG,QAAQ,CAAC;IACxD,IAAI,EAAE,kBAAkB,CAAC;IACzB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC,GACD,IAAI,CACH,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,EAChC,UAAU,GAAG,UAAU,CACvB,CAAC;AAEH,uEAAuE;AACvE,QAAA,MAAM,gBAAgB,oDAMnB,iCAAiC,KAAG,YA4BtC,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAChD,QAAQ,CAAC;IACR,MAAM,EAAE,yBAAyB,CAAC;IAClC,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,SAAS,CAAC;CACrB,CAAC,GACD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;AAE1C,+FAA+F;AAC/F,QAAA,MAAM,oBAAoB,qDAMvB,qCAAqC,KAAG,SAa1C,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG,QAAQ,CAAC;IACtD,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC,GACD,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC,4DAA4D;AAC5D,QAAA,MAAM,cAAc,mEAMjB,+BAA+B,KAAG,YAclC,CAAC;AAEJ,MAAM,MAAM,6BAA6B,GACxC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC,iEAAiE;AACjE,QAAA,MAAM,YAAY,oCAIf,6BAA6B,KAAG,YAQhC,CAAC;AAEJ,MAAM,MAAM,wCAAwC,GACnD,QAAQ,CAAC;IACR,8EAA8E;IAC9E,KAAK,EAAE,MAAM,CAAC;CACd,CAAC,GACD,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC;AAEvD,6DAA6D;AAC7D,QAAA,MAAM,uBAAuB,gCAI1B,wCAAwC,KAAG,YAa3C,CAAC;AAEJ,MAAM,MAAM,+BAA+B,GAAG,QAAQ,CAAC;IACtD,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;CACd,CAAC,GACD,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC;AAEtD,2FAA2F;AAC3F,QAAA,MAAM,cAAc,2CAKjB,+BAA+B,KAAG,YAkBlC,CAAC;AAEJ,MAAM,MAAM,2BAA2B,GACtC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAEjC,wDAAwD;AACxD,QAAA,MAAM,UAAU,oCAIb,2BAA2B,KAAG,YAQ9B,CAAC;AAEJ,KAAK,qBAAqB,GAAG,QAAQ,CAAC;IACrC,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,cAAc,EAAE,OAAO,cAAc,CAAC;IACtC,aAAa,EAAE,OAAO,aAAa,CAAC;IACpC,OAAO,EAAE,OAAO,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,aAAa,CAAC;IACpC,aAAa,EAAE,OAAO,aAAa,CAAC;IACpC,aAAa,EAAE,OAAO,aAAa,CAAC;IACpC,gBAAgB,EAAE,OAAO,gBAAgB,CAAC;IAC1C,oBAAoB,EAAE,OAAO,oBAAoB,CAAC;IAClD,cAAc,EAAE,OAAO,cAAc,CAAC;IACtC,YAAY,EAAE,OAAO,YAAY,CAAC;IAClC,uBAAuB,EAAE,OAAO,uBAAuB,CAAC;IACxD,cAAc,EAAE,OAAO,cAAc,CAAC;CACtC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,YAAY,EAAE,qBAgB1B,CAAC"}