1 Commits
Author SHA1 Message Date
litruv 14f31f57c1 Add a per-user custom typing verb to the typing indicator.
The verb is a profile field (im.paarrot.typing_verb) read through the shared profile cache. The sentence builder replaces the four hardcoded branches, and the profile settings page has presets, a text input, and a live preview.
2026-11-01 01:24:59 +11:00
4 changed files with 349 additions and 61 deletions
+43 -61
View File
@@ -11,6 +11,12 @@ import { getMxIdLocalPart } from '../../utils/matrix';
import * as css from './RoomViewTyping.css';
import { useMatrixClient } from '../../hooks/useMatrixClient';
import { useRoomTypingMember } from '../../hooks/useRoomTypingMembers';
import { useTypingVerbs } from '../../hooks/useUserTypingVerb';
const DEFAULT_VERB = 'typing';
const joinNames = (parts: string[]): string =>
parts.length === 1 ? parts[0] : `${parts.slice(0, -1).join(', ')} and ${parts[parts.length - 1]}`;
export type RoomViewTypingProps = {
room: Room;
@@ -21,17 +27,40 @@ export const RoomViewTyping = as<'div', RoomViewTypingProps>(
const mx = useMatrixClient();
const typingMembers = useRoomTypingMember(room.roomId);
const typingNames = typingMembers
const typers = typingMembers
.filter((receipt) => receipt.userId !== mx.getUserId())
.map(
(receipt) => getMemberDisplayName(room, receipt.userId) ?? getMxIdLocalPart(receipt.userId)
)
.map((receipt) => ({
userId: receipt.userId,
name: getMemberDisplayName(room, receipt.userId) ?? getMxIdLocalPart(receipt.userId),
}))
.reverse();
if (typingNames.length === 0) {
const verbs = useTypingVerbs(typers.map((typer) => typer.userId));
if (typers.length === 0) {
return null;
}
const entries = typers.slice(0, 3).map((typer) => ({
name: typer.name,
verb: verbs[typer.userId],
plural: false,
}));
if (typers.length > 3) {
entries.push({ name: `${typers.length - 3} others`, verb: undefined, plural: true });
}
// One verb for everyone keeps the joined form; mixed verbs need a clause per person
const firstVerb = verbs[typers[0].userId];
const sameVerb = typers.every((typer) => verbs[typer.userId] === firstVerb);
const clauses = entries.map((entry) => ({
name: entry.name,
suffix: `${entry.plural ? 'are' : 'is'} ${entry.verb ?? DEFAULT_VERB}`,
}));
const sharedSuffix = sameVerb
? ` ${entries.length > 1 ? 'are' : 'is'} ${firstVerb ?? DEFAULT_VERB}`
: undefined;
const handleDropAll = () => {
// some homeserver does not timeout typing status
// we have given option so user can drop their typing status
@@ -54,62 +83,15 @@ export const RoomViewTyping = as<'div', RoomViewTypingProps>(
>
<TypingIndicator />
<Text className={css.TypingText} size="T300" truncate>
{typingNames.length === 1 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{' is typing...'}
</Text>
</>
)}
{typingNames.length === 2 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{' and '}
</Text>
<b>{typingNames[1]}</b>
<Text as="span" size="Inherit" priority="300">
{' are typing...'}
</Text>
</>
)}
{typingNames.length === 3 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{', '}
</Text>
<b>{typingNames[1]}</b>
<Text as="span" size="Inherit" priority="300">
{' and '}
</Text>
<b>{typingNames[2]}</b>
<Text as="span" size="Inherit" priority="300">
{' are typing...'}
</Text>
</>
)}
{typingNames.length > 3 && (
<>
<b>{typingNames[0]}</b>
<Text as="span" size="Inherit" priority="300">
{', '}
</Text>
<b>{typingNames[1]}</b>
<Text as="span" size="Inherit" priority="300">
{', '}
</Text>
<b>{typingNames[2]}</b>
<Text as="span" size="Inherit" priority="300">
{' and '}
</Text>
<b>{typingNames.length - 3} others</b>
<Text as="span" size="Inherit" priority="300">
{' are typing...'}
</Text>
</>
)}
{clauses.map((clause, index) => (
<React.Fragment key={index}>
{index > 0 && (index === clauses.length - 1 ? ' and ' : ', ')}
<b>{clause.name}</b>
{!sharedSuffix && ` ${clause.suffix}`}
</React.Fragment>
))}
{sharedSuffix}
{'...'}
</Text>
<IconButton title="Drop Typing Status" size="300" radii="Pill" onClick={handleDropAll}>
<Icon size="50" src={Icons.Cross} />
@@ -41,10 +41,14 @@ import { CollectiblesSection } from './CollectiblesSection';
import { useUserCollectibles } from '../../../hooks/useUserCollectibles';
import { pickAvatarDecorationUrl } from '../../../utils/collectibleAssets';
import * as avatarDecorationCss from '../../../styles/AvatarDecoration.css';
import { useUserTypingVerb } from '../../../hooks/useUserTypingVerb';
import { TypingIndicator } from '../../../components/typing-indicator';
import {
ColorPreference,
hasColorPreference,
parseTypingVerb,
resolveColorForTheme,
TYPING_VERB_PRESETS,
} from '../../../utils/profileFields';
/**
@@ -142,6 +146,44 @@ function ProfileBanner({ avatarRef, nameRef }: { avatarRef: React.RefObject<HTML
setSavingColor(false);
};
const [typingVerb, setTypingVerb, typingVerbLoading] = useUserTypingVerb();
const [localVerb, setLocalVerb] = useState('');
const [savingVerb, setSavingVerb] = useState(false);
const [verbError, setVerbError] = useState<string>();
useEffect(() => {
setLocalVerb(typingVerb ?? '');
}, [typingVerb]);
const handleVerbSave = async () => {
const parsed = parseTypingVerb(localVerb);
if (!parsed) {
setVerbError('Use letters, numbers and single spaces only.');
return;
}
setSavingVerb(true);
setVerbError(undefined);
try {
await setTypingVerb(parsed);
} catch (e) {
setVerbError('Failed to save typing verb. Server may not support profile fields (MSC4133).');
}
setSavingVerb(false);
};
const handleVerbRemove = async () => {
setSavingVerb(true);
setVerbError(undefined);
try {
await setTypingVerb(undefined);
setLocalVerb('');
} catch (e) {
setVerbError('Failed to remove typing verb');
}
setSavingVerb(false);
};
const [isEditingName, setIsEditingName] = useState(false);
const [editedName, setEditedName] = useState(profile.displayName || '');
const [savingName, setSavingName] = useState(false);
@@ -1024,6 +1066,101 @@ function ProfileBanner({ avatarRef, nameRef }: { avatarRef: React.RefObject<HTML
)}
</Box>
{/* Paarrot custom typing verb */}
<Box
direction="Column"
gap="300"
style={{
padding: config.space.S400,
border: `${toRem(1)} solid ${color.Surface.ContainerLine}`,
borderRadius: toRem(8),
width: '100%',
boxSizing: 'border-box',
}}
>
<Text size="H6">Typing verb</Text>
<Box gap="200" wrap="Wrap" alignItems="Center">
{TYPING_VERB_PRESETS.map((preset) => (
<Box
key={preset}
as="button"
onClick={() => {
setLocalVerb(preset);
setVerbError(undefined);
}}
style={{
backgroundColor: color.Surface.Container,
border: `${toRem(1)} solid ${color.Surface.ContainerLine}`,
padding: `${toRem(4)} ${toRem(8)}`,
borderRadius: toRem(16),
cursor: 'pointer',
}}
>
<Text size="B300">{preset}</Text>
</Box>
))}
</Box>
<Input
size="300"
variant="Secondary"
style={{ width: '100%' }}
value={localVerb}
onChange={(e) => {
setLocalVerb(e.target.value);
setVerbError(undefined);
}}
placeholder="Custom typing verb..."
maxLength={48}
/>
<Box gap="200" alignItems="Center">
<Avatar size="300">
<UserAvatar
userId={userId}
src={avatarUrl}
alt={userId}
renderFallback={() => <Icon size="200" src={Icons.User} filled />}
/>
</Avatar>
<TypingIndicator />
<Text size="T300">
<b>{profile.displayName || getMxIdLocalPart(userId)}</b>
{` is ${parseTypingVerb(localVerb) ?? 'typing'}...`}
</Text>
</Box>
<Box gap="200" alignItems="Center" wrap="Wrap">
<Button
size="300"
variant="Primary"
fill="Solid"
radii="300"
onClick={handleVerbSave}
disabled={savingVerb || typingVerbLoading}
>
<Text size="B300">{savingVerb ? 'Saving...' : 'Save verb'}</Text>
</Button>
{typingVerb && (
<Button
size="300"
variant="Critical"
fill="Soft"
radii="300"
onClick={handleVerbRemove}
disabled={savingVerb}
>
<Text size="B300">Remove verb</Text>
</Button>
)}
</Box>
{verbError && (
<Text size="T200" style={{ color: color.Critical.Main }}>{verbError}</Text>
)}
</Box>
<Box
direction="Column"
gap="300"
+114
View File
@@ -0,0 +1,114 @@
import { useCallback, useEffect, useState } from 'react';
import { useMatrixClient } from './useMatrixClient';
import {
PROFILE_KEY_TYPING_VERB,
deleteTypingVerb,
parseTypingVerb,
saveTypingVerb,
} from '../utils/profileFields';
import {
getCachedProfileFields,
getProfileFields,
registerProfileCacheListener,
} from '../utils/profileCache';
/**
* Hook to manage the user's custom typing verb on their global profile.
*/
export function useUserTypingVerb(): [
string | undefined,
(verb: string | undefined) => Promise<void>,
boolean
] {
const mx = useMatrixClient();
const [verb, setVerb] = useState<string | undefined>();
const [loading, setLoading] = useState(true);
useEffect(() => {
const userId = mx.getUserId();
if (!userId) {
setLoading(false);
return undefined;
}
let cancelled = false;
const load = async () => {
setLoading(true);
try {
const fields = await getProfileFields(mx, userId);
const loaded = parseTypingVerb(fields[PROFILE_KEY_TYPING_VERB]);
if (!cancelled) setVerb(loaded);
} catch (e) {
console.error('Failed to load typing verb:', e);
if (!cancelled) setVerb(undefined);
}
if (!cancelled) setLoading(false);
};
load();
return () => {
cancelled = true;
};
}, [mx]);
const updateVerb = useCallback(
async (newVerb: string | undefined) => {
const parsed = parseTypingVerb(newVerb);
if (!parsed) {
await deleteTypingVerb(mx);
setVerb(undefined);
return;
}
await saveTypingVerb(mx, parsed);
setVerb(parsed);
},
[mx]
);
return [verb, updateVerb, loading];
}
/** Typing verb for a user already in the shared profile cache. */
export function getCachedTypingVerb(userId: string): string | undefined {
const fields = getCachedProfileFields(userId);
return fields ? parseTypingVerb(fields[PROFILE_KEY_TYPING_VERB]) : undefined;
}
/**
* Typing verbs for a group of users. Hooks cannot be called per typing user, so this
* reads the shared profile cache and re-renders when a cache entry arrives. Only cache
* misses are fetched.
*/
export function useTypingVerbs(userIds: string[]): Record<string, string | undefined> {
const mx = useMatrixClient();
const [, setTick] = useState(0);
const key = userIds.join(',');
useEffect(() => {
if (!key) return undefined;
let cancelled = false;
const unsubscribe = registerProfileCacheListener(() => setTick((tick) => tick + 1));
for (const userId of key.split(',')) {
if (getCachedProfileFields(userId)) continue;
// setProfileCache does not notify listeners, so a fresh fetch has to re-render here
getProfileFields(mx, userId)
.then(() => {
if (!cancelled) setTick((tick) => tick + 1);
})
.catch(() => undefined);
}
return () => {
cancelled = true;
unsubscribe();
};
}, [mx, key]);
const verbs: Record<string, string | undefined> = {};
for (const userId of userIds) verbs[userId] = getCachedTypingVerb(userId);
return verbs;
}
+55
View File
@@ -23,6 +23,38 @@ export const PROFILE_KEY_NAMEPLATE = 'im.paarrot.nameplate';
/** Paarrot avatar decoration (avatar frame) */
export const PROFILE_KEY_AVATAR_DECORATION = 'im.paarrot.avatar_decoration';
/** Paarrot custom typing verb (shown in the typing indicator) */
export const PROFILE_KEY_TYPING_VERB = 'im.paarrot.typing_verb';
export const TYPING_VERB_PRESETS: string[] = [
'typing',
'cooking',
'thinking',
'plotting',
'brewing',
'sketching',
'humming',
'whispering',
'doodling',
'lurking',
'scheming',
'daydreaming',
];
const TYPING_VERB_MAX_LENGTH = 48;
/** Profile data arrives as unknown from the homeserver, so it is validated here. */
export function parseTypingVerb(value: unknown): string | undefined {
if (typeof value !== 'string') return undefined;
const verb = value
.replace(/[^a-zA-Z0-9 ]/g, '')
.replace(/ {2,}/g, ' ')
.trim();
if (!verb || verb.length > TYPING_VERB_MAX_LENGTH) return undefined;
return verb;
}
export type StoredCollectible = {
sku_id: string;
name: string;
@@ -230,3 +262,26 @@ export async function deleteColorPreference(mx: MatrixClient): Promise<void> {
const userId = mx.getUserId();
if (userId) clearProfileCache(userId);
}
export async function saveTypingVerb(mx: MatrixClient, verb: string): Promise<void> {
if (!(await mx.doesServerSupportExtendedProfiles())) {
throw new Error('Server does not support extended profile fields (MSC4133)');
}
const value = parseTypingVerb(verb);
if (!value) throw new Error('Invalid typing verb');
await mx.setExtendedProfileProperty(PROFILE_KEY_TYPING_VERB, value);
const userId = mx.getUserId();
if (userId) clearProfileCache(userId);
}
export async function deleteTypingVerb(mx: MatrixClient): Promise<void> {
if (!(await mx.doesServerSupportExtendedProfiles())) {
throw new Error('Server does not support extended profile fields (MSC4133)');
}
await mx.deleteExtendedProfileProperty(PROFILE_KEY_TYPING_VERB);
const userId = mx.getUserId();
if (userId) clearProfileCache(userId);
}