MotionSwipe

滑動顯示操作按鈕、並可選擇滑動刪除的清單列。

WebReact Native手勢

動手試試

正在準備範例…

JavaScript 已關閉。下方的程式碼就是完整的範例。

App.jsx

import { useState } from 'react';
import { MotionList, MotionSwipe, motionTokens } from '@kkwaenggwari/animated-chorus';
import './styles.css';

const inbox = [
  { id: 1, from: 'Design team', subject: 'New motion tokens are ready' },
  { id: 2, from: 'Build bot', subject: 'All checks passed on main' },
  { id: 3, from: 'Hana', subject: 'Lunch on Friday?' },
  { id: 4, from: 'Support', subject: 'Your export is complete' },
];

export default function App({ dismiss = 'end', spring = 'default' }) {
  const [messages, setMessages] = useState(inbox);
  const [pinned, setPinned] = useState([]);
  const remove = (id) => setMessages(messages.filter((message) => message.id !== id));
  const pin = (id) =>
    setPinned(pinned.includes(id) ? pinned.filter((item) => item !== id) : [...pinned, id]);

  return (
    <div className="stage">
      {/* The list animates rows that leave by a button and rows that come back. */}
      <MotionList
        className="rows"
        items={messages}
        renderItem={(message) => (
          <MotionSwipe
            className="row"
            contentClassName="content"
            dismiss={dismiss === 'none' ? undefined : dismiss}
            onDismiss={() => remove(message.id)}
            transition={motionTokens.spring[spring]}
            startActions={
              <button className="action pin" onClick={() => pin(message.id)}>
                {pinned.includes(message.id) ? 'Unpin' : 'Pin'}
              </button>
            }
            endActions={
              <button className="action archive" onClick={() => remove(message.id)}>
                Archive
              </button>
            }
          >
            <strong>
              {pinned.includes(message.id) ? '● ' : ''}
              {message.from}
            </strong>
            <span>{message.subject}</span>
          </MotionSwipe>
        )}
      />
      {messages.length === 0 && <p className="empty">Inbox zero.</p>}
      <button className="restore" onClick={() => setMessages(inbox)}>
        Restore messages
      </button>
    </div>
  );
}

styles.css

.stage {
  display: grid;
  gap: 8px;
  max-width: 520px;
  margin: 0 auto;
  padding: 24px 20px;
}

.rows {
  display: grid;
  gap: 8px;
  margin: 0;
  padding: 0;
  list-style: none;
}

.row {
  border-radius: 14px;
  background: #eaf6f0;
}

.content {
  display: grid;
  gap: 2px;
  padding: 14px 18px;
  border: 1px solid #cfe8dc;
  border-radius: 14px;
  background: #fff;
  user-select: none;
}

.content strong {
  color: #0e2e24;
}

.content span {
  color: #5b616b;
}

.action {
  height: 100%;
  min-width: 88px;
  padding: 0 18px;
  border: 0;
  font:
    650 14px system-ui,
    sans-serif;
  color: #fff;
  cursor: pointer;
}

.archive {
  border-radius: 0 14px 14px 0;
  background: #176b52;
}

.pin {
  border-radius: 14px 0 0 14px;
  background: #2e8f6d;
}

.empty {
  margin: 12px 0;
  color: #5b616b;
  text-align: center;
}

.restore {
  justify-self: center;
  min-height: 40px;
  margin-top: 8px;
  padding: 0 16px;
  border: 1px solid #cfe8dc;
  border-radius: 999px;
  background: #fff;
  font:
    600 14px system-ui,
    sans-serif;
  cursor: pointer;
}

最簡用法

Row.jsx

<MotionSwipe
  endActions={<button onClick={() => archive(id)}>Archive</button>}
  dismiss="end"
  onDismiss={() => remove(id)}
>
  <MessagePreview />
</MotionSwipe>;

它替你處理的事

列會跟著水平拖曳，超過操作按鈕時有阻力，並依你放開時的速度停穩。
設定 dismiss 後，長距離滑動或快速甩出會讓列滑出、收起高度，然後呼叫 onDismiss(side)。
垂直捲動照常可用，同一時間只有一列保持展開。
點擊已展開的列會將它收起，鍵盤焦點移到操作按鈕上時會將它顯示出來。

適用情境

在收件匣中封存或刪除。
置頂一段對話。
從清單中移除一個項目。

Props

Prop	型別	預設值	說明
`children`	`ReactNode`		列的內容。
`startActions`	`ReactNode`		把列往結尾方向拖曳時，在行內開頭一側顯示。
`endActions`	`ReactNode`		把列往開頭方向拖曳時，在行內結尾一側顯示。
`dismiss`	`'start' \| 'end' \| 'both'`		長距離滑動或快速甩出會移除該列的方向。
`onDismiss`	`(side) => void`		列滑出並收起後執行；請在這裡把該項目從資料中移除。
`onOpenChange`	`(side \| null) => void`		帶著展開的那一側執行，列收起時為 `null`。
`disabled`	`boolean`	`false`	關閉滑動。
`contentClassName`	`string`		列內容的 class；`contentStyle` 設定其行內樣式。
`transition`	`Transition`	`spring`	時間曲線 `{ duration, easing }` 或彈簧 `{ tempo: 'spring', spring }`。彈簧被中斷時會保留動量。

其他 props 會傳給渲染的元素，所以 className、style 與事件處理函式照常可用。

Web 與 React Native

往行內結尾方向拖曳時出現 startActions，往開頭方向拖曳時出現 endActions。以 contentClassName 為列的內容設定背景。

React Native 使用相同的 props 與手勢。

用到它的範例

收件匣附即時計數的篩選分頁、可以滑走的列，以及會自動補上空隙的清單。MotionHighlightMotionListMotionSwipeMotionNumber