@hzblj/kara-components 0.10.0 → 0.11.0

package/src/organisms/fab-menu/fab-menu.types.ts

@@ -9,6 +9,11 @@ import type {MenuAction} from '../menu'
  * label of a SwiftUI `Menu`. A native atom: it renders inside `<Screen>` or `<Island>`.
  */
 export type FabMenuProps = {
+  /**
+   * What VoiceOver and TalkBack say for the button, since an icon has no words of its own: "Create". Required for that
+   * reason.
+   */
+  accessibilityLabel: string
   /** The actions the button unfolds into. */
   actions: MenuAction[]
   /** The closed button's icon, one of the app's. A plus by default. */

package/src/organisms/snackbar/snackbar.tsx

@@ -1,41 +1,165 @@
-import {FadeInDown, FadeOutDown} from 'react-native-reanimated'
+import {duration as durations, easing, spacing, useReducedMotion} from '@hzblj/kara-theme'
+import {useEffect, useRef} from 'react'
+import {AccessibilityInfo, Platform} from 'react-native'
+import {
+  Easing,
+  type EntryExitAnimationFunction,
+  FadeIn,
+  FadeInDown,
+  FadeInUp,
+  FadeOut,
+  FadeOutDown,
+  FadeOutUp,
+  ReduceMotion,
+  withTiming,
+} from 'react-native-reanimated'
 
-import {ABox} from '../../atoms/box'
+import {ABox, Box} from '../../atoms/box'
 import {Pressable} from '../../atoms/pressable'
 import {RnText} from '../../atoms/rn-text'
-import type {SnackbarComponent, SnackbarProps} from './snackbar.types'
+import {RnGlyph} from '../../glyph'
+import {timing} from '../../motion'
+import type {SnackbarAnimation, SnackbarComponent, SnackbarDuration, SnackbarProps} from './snackbar.types'
+
+/** Material's `SnackbarDuration.Short` and `Long`. */
+const DURATIONS = {long: 10_000, short: 4_000} as const
+
+const PLATFORM_ANIMATION: SnackbarAnimation = Platform.OS === 'android' ? 'scale' : 'slide'
+
+/** The close glyph at the label's height: an SF Symbol fills its box, Material's icon sits inside a padded one. */
+const CLOSE_SIZE = Platform.OS === 'ios' ? 's12' : 's16'
+
+const SMOOTH_OUT = Easing.bezier(...easing.smoothOut)
+const GROW = timing('quick')
+
+/** Material's snackbar enter: it fades in while it grows from 80 %, in 150 ms. */
+const scaleIn: EntryExitAnimationFunction = () => {
+  'worklet'
+
+  return {
+    animations: {opacity: withTiming(1, GROW), transform: [{scale: withTiming(1, GROW)}]},
+    initialValues: {opacity: 0, transform: [{scale: 0.8}]},
+  }
+}
+
+/**
+ * The presets in and out: arriving in `fast`, leaving in `quick`, both on `smoothOut`. `ReduceMotion.Never`, because
+ * `useReducedMotion` has already picked the fade by then, and a fade is what should still run.
+ */
+const TRANSITIONS = {
+  fade: {
+    entering: FadeIn.duration(durations.fast).easing(SMOOTH_OUT).reduceMotion(ReduceMotion.Never),
+    exiting: FadeOut.duration(durations.quick).easing(SMOOTH_OUT).reduceMotion(ReduceMotion.Never),
+  },
+  // Material's exit is a 75 ms fade: `micro`.
+  scale: {entering: scaleIn, exiting: FadeOut.duration(durations.micro).reduceMotion(ReduceMotion.Never)},
+  // Slide: in from the edge it sits on, and back out toward it.
+  slideBottom: {
+    entering: FadeInDown.duration(durations.fast).easing(SMOOTH_OUT).reduceMotion(ReduceMotion.Never),
+    exiting: FadeOutDown.duration(durations.quick).easing(SMOOTH_OUT).reduceMotion(ReduceMotion.Never),
+  },
+  slideTop: {
+    entering: FadeInUp.duration(durations.fast).easing(SMOOTH_OUT).reduceMotion(ReduceMotion.Never),
+    exiting: FadeOutUp.duration(durations.quick).easing(SMOOTH_OUT).reduceMotion(ReduceMotion.Never),
+  },
+}
+
+const transitionsFor = (animation: SnackbarAnimation, position: 'bottom' | 'top') => {
+  if (animation === 'slide') {
+    return position === 'top' ? TRANSITIONS.slideTop : TRANSITIONS.slideBottom
+  }
+
+  return TRANSITIONS[animation]
+}
+
+const millisecondsOf = (duration: SnackbarDuration) =>
+  typeof duration === 'number' ? duration : duration === 'indefinite' ? undefined : DURATIONS[duration]
+
+export const Snackbar: SnackbarComponent = ({
+  actionLabel,
+  actionOnNewLine = false,
+  animation = PLATFORM_ANIMATION,
+  dismissible = false,
+  duration = 'indefinite',
+  entering,
+  exiting,
+  message,
+  offset = 's24',
+  onAction,
+  onDismiss,
+  position = 'bottom',
+  visible,
+}: SnackbarProps) => {
+  const reduced = useReducedMotion()
+  // A caller's inline `onDismiss` is a new function every render; the timer must not restart for it.
+  const dismiss = useRef(onDismiss)
+  dismiss.current = onDismiss
+
+  // biome-ignore lint/correctness/useExhaustiveDependencies: a new `message` restarts the timer, as a new snackbar
+  useEffect(() => {
+    const milliseconds = millisecondsOf(duration)
+
+    if (!visible || milliseconds === undefined) {
+      return
+    }
+
+    const timer = setTimeout(() => dismiss.current?.(), milliseconds)
+
+    return () => clearTimeout(timer)
+  }, [duration, message, visible])
+
+  // Material's snackbar is announced; a React Native view is not unless asked.
+  useEffect(() => {
+    if (visible) {
+      AccessibilityInfo.announceForAccessibility(message)
+    }
+  }, [message, visible])
 
-export const Snackbar: SnackbarComponent = ({actionLabel, message, onAction, visible}: SnackbarProps) => {
   if (!visible) {
     return null
   }
 
+  const edge = position === 'top' ? {top: spacing[offset]} : {bottom: spacing[offset]}
+  const hasTrailing = Boolean(actionLabel) || dismissible
+  // With motion reduced it only fades: nothing slides or grows.
+  const preset = transitionsFor(reduced ? 'fade' : animation, position)
+
   return (
     <ABox
-      align="center"
+      align={actionOnNewLine ? 'stretch' : 'center'}
       bg="surface.high.contrast"
       borderRadius="medium"
-      bottom={24}
-      entering={FadeInDown}
-      exiting={FadeOutDown}
-      flexDirection="row"
-      gap="s12"
-      left={16}
+      flexDirection={actionOnNewLine ? 'column' : 'row'}
+      gap={actionOnNewLine ? 's8' : 's12'}
+      left={spacing.s16}
       position="absolute"
       px="s16"
       py="s12"
-      right={16}
+      right={spacing.s16}
       shadow="snackbar"
+      {...edge}
+      entering={entering ?? preset.entering}
+      exiting={exiting ?? preset.exiting}
     >
-      <RnText color="content.on.high.contrast" variant="footnote">
+      {/* It takes the room, so the action sits at the trailing end, as far in from it as the message is from the start. */}
+      <RnText color="content.on.high.contrast" flex={actionOnNewLine ? undefined : 1} variant="footnote">
         {message}
       </RnText>
-      {actionLabel ? (
-        <Pressable onPress={onAction}>
-          <RnText color="content.accent" variant="footnoteMedium">
-            {actionLabel}
-          </RnText>
-        </Pressable>
+      {hasTrailing ? (
+        <Box align="center" alignSelf={actionOnNewLine ? 'flex-end' : undefined} flexDirection="row" gap="s16">
+          {actionLabel ? (
+            <Pressable onPress={onAction} pressEffect="opacity" ripple={false}>
+              <RnText color="content.accent" variant="footnoteMedium">
+                {actionLabel}
+              </RnText>
+            </Pressable>
+          ) : null}
+          {dismissible ? (
+            <Pressable accessibilityLabel="Dismiss" onPress={onDismiss} pressEffect="opacity" ripple={false}>
+              <RnGlyph color="content.on.high.contrast" name="close" size={CLOSE_SIZE} />
+            </Pressable>
+          ) : null}
+        </Box>
       ) : null}
     </ABox>
   )

package/src/organisms/snackbar/snackbar.types.ts

@@ -1,17 +1,53 @@
-import type {ReactNode} from 'react'
+import type {SpaceSize} from '@hzblj/kara-theme'
+import type {ComponentProps, ReactNode} from 'react'
+import type Animated from 'react-native-reanimated'
+
+type LayoutAnimation = ComponentProps<typeof Animated.View>['entering']
+
+/** How it comes and goes. */
+export type SnackbarAnimation = 'fade' | 'scale' | 'slide'
+
+/** How long it stays: Material's short (4 s) and long (10 s), never, or a number of milliseconds. */
+export type SnackbarDuration = 'indefinite' | 'long' | 'short' | number
+
+/** The edge of its parent it sits on. */
+export type SnackbarPosition = 'bottom' | 'top'
 
 /**
- * A short message laid over the bottom of its parent, with an optional action. The React Native tier, drawn the same on
- * both platforms: it needs no host, and it never hides itself.
+ * A short message laid over an edge of its parent, with an optional action at its trailing end. The React Native tier,
+ * drawn the same on both platforms (iOS has no snackbar of its own), so it needs no host. Material's options are all
+ * here: a duration, a dismiss button, the action on a line of its own. It is announced to VoiceOver and TalkBack when
+ * it appears.
  */
 export type SnackbarProps = {
-  /** The action button's text, on the trailing side. No button without it. */
+  /** The action button's text, at the trailing end. No button without it. */
   actionLabel?: string
+  /** Puts the action under the message, at its trailing end: Material's layout for a long message or action. */
+  actionOnNewLine?: boolean
+  /**
+   * How it comes and goes. `scale` is Material's own (a fade and a scale from 80 %), `slide` rises from its edge as it
+   * fades in, `fade` only fades. `scale` on Android and `slide` on iOS by default. With motion reduced, it fades.
+   */
+  animation?: SnackbarAnimation
+  /** A close button at the trailing end, Material's dismiss action; it calls `onDismiss`. */
+  dismissible?: boolean
+  /** How long it stays up before `onDismiss` is called. `indefinite` by default: it never hides itself. */
+  duration?: SnackbarDuration
+  /** A Reanimated entering animation of your own, e.g. `FadeInDown.springify()`. It wins over `animation`. */
+  entering?: LayoutAnimation
+  /** A Reanimated exiting animation of your own. It wins over `animation`. */
+  exiting?: LayoutAnimation
   /** The message. */
   message: string
+  /** Between the snackbar and its edge, a space token. `s24` by default; raise it above a tab bar. */
+  offset?: SpaceSize
   /** The action was pressed. The snackbar stays up; turn `visible` off to hide it. */
   onAction?: () => void
-  /** Shows the snackbar while true, fading it in and out. It sets no timer of its own. */
+  /** It asks to go: its `duration` ran out, or its dismiss button was pressed. Turn `visible` off to hide it. */
+  onDismiss?: () => void
+  /** The edge of its parent it sits on. `bottom` by default, Material's place for it. */
+  position?: SnackbarPosition
+  /** Shows the snackbar while true, animating it in and out. */
   visible: boolean
 }
 

package/src/organisms/swipe-actions/swipe-actions.android.tsx

@@ -49,7 +49,7 @@ type ActionButtonProps = {action: SwipeAction; onDone: () => void}
 const ActionButton = ({action, onDone}: ActionButtonProps) => {
   const theme = useAppTheme()
   const fill = action.tint ?? (action.destructive ? 'fill.destructive.primary' : 'fill.accent.primary')
-  const content = !action.tint && action.destructive ? 'content.on.destructive' : 'content.on.bg'
+  const content = !action.tint && action.destructive ? 'content.on.destructive' : 'content.on.accent'
 
   const onClick = useCallback(() => {
     onDone()

package/src/use-stack-modifiers.ts

@@ -1,24 +1,37 @@
 import {clickable, type ModifierConfig, testID as testIdModifier} from '@expo/ui/jetpack-compose/modifiers'
-import {type ResponsiveSx, useSxModifiers} from '@hzblj/kara-sx'
+import {
+  type AccessibilityProps,
+  type ResponsiveSx,
+  splitAccessibility,
+  useAccessibilityModifiers,
+  useSxModifiers,
+} from '@hzblj/kara-sx'
 import {useMemo} from 'react'
 
 /**
- * A Compose stack's modifiers in the order a pressable one needs: its frame, shape and background, then the press,
- * then its padding. Compose clips a `clickable` to what comes after it, so with the padding first the ripple would stop
- * at the padding and a row pressed by its edge would light up only in the middle.
+ * A Compose stack's modifiers in the order a pressable one needs: its frame, shape and background, then the press, its
+ * semantics, then its padding. Compose clips a `clickable` to what comes after it, so with the padding first the ripple
+ * would stop at the padding and a row pressed by its edge would light up only in the middle. The semantics come after
+ * the click, because a label that replaces the children's clears whatever semantics are inside it.
  */
-export const useStackModifiers = (sx: ResponsiveSx, onPress?: () => void, testID?: string): ModifierConfig[] => {
-  const {p, pb, pl, pr, pt, px, py, ...frame} = sx
+export const useStackModifiers = (
+  props: ResponsiveSx & AccessibilityProps,
+  onPress?: () => void,
+  testID?: string
+): ModifierConfig[] => {
+  const [accessibility, {p, pb, pl, pr, pt, px, py, ...frame}] = splitAccessibility(props)
   const frameModifiers = useSxModifiers(frame)
   const paddingModifiers = useSxModifiers({p, pb, pl, pr, pt, px, py})
+  const accessibilityModifiers = useAccessibilityModifiers(accessibility, onPress !== undefined)
 
   return useMemo(
     () => [
       ...frameModifiers,
       ...(testID ? [testIdModifier(testID)] : []),
       ...(onPress ? [clickable(onPress)] : []),
+      ...accessibilityModifiers,
       ...paddingModifiers,
     ],
-    [frameModifiers, onPress, paddingModifiers, testID]
+    [accessibilityModifiers, frameModifiers, onPress, paddingModifiers, testID]
   )
 }