بناء تدفقات onClick وonDoubleClick وonHold في RxJS
مثال عملي على استخدام RxJS لبناء تجريد مريح فوق أحداث onClick وonDoubleClick وonHold.
في هذه المقالة نستعرض مثالًا عمليًا على استخدام RxJS لبناء تجريد مريح فوق أحداث onClick وonDoubleClick وonHold. ستكتشف مدى سهولة الجمع بين العناصر الأساسية في RxJS للوصول إلى حل تصريحي مقروء وعام في الوقت نفسه، يمكننا لاحقًا توسيعه بسهولة لإنتاج تدفقات أخرى مثل onTripleClick وغيرها.
هذه الإيماءات الثلاث شائعة جدًا في واجهات المستخدم المعتمدة على العتاد، كالساعات مثلًا، ومع ذلك لا شيء يمنعنا من استخدامها في تصاميم رقمية أحدث أيضًا.
تعريف نظامنا
لنبدأ بالنظر في الأحداث الموجودة في «نظامنا». فكل نقرة وكل ضغطة مطوّلة تنشأ من ضغط المستخدم على زر أو شاشة ثم رفع إصبعه. أي أن الحدثين الوحيدين اللذين يصلاننا من «الخارج» هما حدث down وحدث up. ولاحظ أنه لا فرق إن كان المستخدم يلمس شاشة أو يضغط مفتاحًا في لوحة المفاتيح أو ينقر بالفأرة – فالمنطق يبقى نفسه. لنعبّر عن ذلك في RxJS:
import { Subject } from "rxjs";
export const downSubject = new Subject<"down">();
export const upSubject = new Subject<"up">();
const down$ = downSubject.asObservable();
const up$ = upSubject.asObservable();
وفيما بعد، سنعتمد على هذه الـ subjects لترجمة أحداث معينة، مثل MouseDown وMouseUp في React، إلى منطقنا المستقل عن المنصة.
القيم الفعلية التي تبثها هذه التدفقات ليست مهمة، ما دمنا نستطيع التمييز بينها. وتكفي سلاسل نصية بسيطة، لكن إن أردنا يومًا إرفاق بيانات بالأحداث – كإحداثيات x وy للفأرة عند وقوع الحدث مثلًا – فيمكننا كتابة شيء على هذا النحو:
type Event<T extends string> = {
type: T;
// add payload here if needed
};
export const downSubject = new Subject<Event<"down">>(); // changed
export const upSubject = new Subject<Event<"up">>(); // changed
حسنًا، ما التالي؟ لننظر في ماهية النقرة فعلًا على المستوى المنخفض. حين نريد، كمستخدمين، النقر على شيء ما، فإننا:
- نضغط عليه ببساطة ثم نتركه فورًا
- لا نريد أن نشعر وكأننا في سباق وعلينا الانتباه الشديد إلى رفع الإصبع بسرعة كافية لتفادي تشغيل إجراء آخر عن غير قصد
كان تنفيذ النقرات وحدها سيكون بسيطًا:
const click$ = down$.pipe(
switchMap(() =>
up$.pipe(map(() => ({ type: "click" } as Event<"click">)))
)
);
click$.subscribe(console.log);
في كل مرة يقع فيها حدث down، نشترك في تدفق أحداث up، وعندما يقع حدث up نحوّله إلى حدث click.
تحسين تدفق click
وبالمناسبة، نفترض هنا أن التدفق المشترك لأحداث down وup يبدو هكذا::
D--U-----D-U-----DU--DU---->
بعبارة أخرى، لا يصل حدثا down أحدهما بعد الآخر، وكذلك الحال مع أحداث up. فهل هذا الافتراض صحيح؟
بصراحة، لا أستطيع أن أتخيل واجهة تتيح لنا الضغط على شيء مرتين (بإصبع ثانٍ؟) وتركه مرة واحدة فقط. لكن تخيّل حالة نعمل فيها مع وصلة شبكة غير موثوقة تكرر الأحداث أحيانًا بشكل عشوائي.
فلو تكرر حدث up مثلًا، فإن تنفيذنا الحالي سينتج نقرتين بدلًا من نقرة واحدة.
لحسن الحظ، يمكننا ببساطة إلغاء الاشتراك في up$ بمجرد وصول حدث واحد:
const click$ = down$.pipe(
switchMap(() =>
up$.pipe(
take(1) // new
).pipe(map(() => ({ type: "click" } as Event<"click">)))
)
);
click$.subscribe(console.log);
الآن، مهما بلغ عدد أحداث up وdown الواصلة، سننتج نقرة واحدة لكل زوج مميز يتكون من حدث down وحدث up لاحق. رائع!
يوضح هذا المثال أنه مع فهم جيد لكيفية سلوك التدفقات، نستطيع غالبًا تلبية متطلبات متنوعة بجهد قليل جدًا، باستخدام مشغّل RxJS واحد فقط.
تدفق أحداث الضغط المطوّل
بعد ذلك، لنعرّف الأحداث التي نريد إنتاجها، مع بعض دوال إنشاء الأحداث:
type Click = Event<"click">;
type DoubleClick = Event<"doubleClick">;
type Hold = Event<"hold">;
const createClick = () => ({ type: "click" } as Click);
const createDoubleClick = () => ({ type: "doubleClick" } as DoubleClick);
const createHold = () => ({ type: "hold" } as Hold);
بمجرد وقوع حدث down، لا يوجد سوى احتمالين: تحويله إلى click أو تحويله إلى hold. وسيُبَثّ hold تلقائيًا إذا مرّت فترة زمنية معينة دون حدث up. أي أن لدينا سباقًا بين مؤقت يطلق حدث hold وحدث up يطلق click ويلغي المؤقت. وهذا بالضبط ما سننفذه:
const HOLD_INTERVAL = 500;
const clickOrHold$ = down$.pipe(
switchMap(() =>
up$.pipe(
map(createClick),
raceWith(timer(HOLD_INTERVAL).pipe(map(createHold)))
)
)
);
clickOrHold$.subscribe(console.log);
ولزيادة الراحة، يمكننا أيضًا إعداد تدفق منفصل لكل إيماءة:
const click$ = clickOrHold$.pipe(
filter((event) => event.type === "click")
);
const hold$ = clickOrHold$.pipe(
filter((event) => event.type === "hold")
);
النقرات المزدوجة
ممتاز – الإيماءة الوحيدة المتبقية هي doubleClick. وبما أن لدينا أصلًا تدفقًا ينتج أحداث click أو hold، سنطبّق المشغّل filter للإبقاء على النقرات فقط، ثم نقيس الزمن المنقضي بين النقرات المتتالية، وإذا كانت متقاربة بما يكفي، نحوّلها إلى doubleClick:
const DOUBLE_CLICK_INTERVAL = 300;
const doubleClick$ = click$.pipe(
timeInterval(),
filter(({ interval }) => interval < DOUBLE_CLICK_INTERVAL),
map(createDoubleClick)
);
doubleClick$.subscribe(console.log);
استخدمنا هنا المشغّل timeInterval، الذي يضيف حقل interval يحمل الزمن المنقضي بين عمليات البث المتتالية.
جمع كل شيء معًا
قد تظن أن الدالة merge هي كل ما نحتاجه لبناء تدفق يبث كل الإيماءات:
// won't work as we would expect
export const gestures$ = merge(click$, hold$, doubleClick$);
لكن كلما نقر المستخدم نقرتين سريعتين متتاليتين، سينتج ذلك التدفق 3 أحداث: click وclick وdoubleClick! على الأرجح نفضّل أن يبث حدث doubleClick واحدًا فقط.
وقد تكون أول فكرة تخطر على البال هي تنفيذه بالطريقة نفسها التي بنينا بها clickOrHold$:
// won't work!
const clickOrDoubleClick$ = click$.pipe(
switchMap(() =>
click$.pipe(
map(createDoubleClick),
raceWith(timer(HOLD_INTERVAL).pipe(map(createClick)))
)
)
);
للأسف، يفشل هذا لأن الـ observable الخارجي والـ observable الداخلي في switchMap هما نفسه، فبمجرد وصول click ثانية نلغي الاشتراك في الـ observable الداخلي فورًا ولا نبث حدث doubleClick أبدًا.
لذلك سنلجأ إلى تقنية أخرى واسعة الاستخدام. سنجمع النقرات الواردة في مصفوفة ونبث حدثًا بحسب طول هذه المصفوفة:
const DOUBLE_CLICK_INTERVAL = 200;
const clickOrDoubleClick$ = click$.pipe(
buffer(click$.pipe(switchMap(() => timer(DOUBLE_CLICK_INTERVAL)))),
map((clicksArr) =>
clicksArr.length > 1 ? createDoubleClick() : createClick()
)
);
يجمع المشغّل buffer القيم إلى أن يبث الـ observable الممرَّر إليه كمعامل. فالحيلة كلها إذن في تمرير المعامل الصحيح. وفي هذه الحالة مرّرتُ observable يبث 0 (يبث timer القيمة 0؛ والقيمة نفسها غير مهمة هنا) بعد 200 مللي ثانية من كل حدث click. فإذا نقر المستخدم مرتين (أو أكثر) خلال تلك النافذة، ستحتوي المصفوفة على أكثر من عنصر واحد وسنحوّلها إلى doubleClick.
وأخيرًا يمكننا بناء تدفق إيماءات يعمل بشكل صحيح:
export const gestures$ = merge(clickOrDoubleClick$, hold$);
الشيفرة الكاملة ومثال على الاستخدام
فيما يلي كل الشيفرة التي كتبناها:
import {
buffer,
filter,
map,
merge,
raceWith,
Subject,
switchMap,
timer,
} from "rxjs";
type Event<T extends string> = {
type: T;
};
export const downSubject = new Subject<Event<"down">>();
export const upSubject = new Subject<Event<"up">>();
const down$ = downSubject.asObservable();
const up$ = upSubject.asObservable();
export type Click = Event<"click">;
export type DoubleClick = Event<"doubleClick">;
export type Hold = Event<"hold">;
const createClick = () => ({ type: "click" } as Click);
const createDoubleClick = () => ({ type: "doubleClick" } as DoubleClick);
const createHold = () => ({ type: "hold" } as Hold);
const HOLD_INTERVAL = 500;
const clickOrHold$ = down$.pipe(
switchMap(() =>
up$.pipe(
map(createClick),
raceWith(timer(HOLD_INTERVAL).pipe(map(createHold)))
)
)
);
const click$ = clickOrHold$.pipe(filter((event) => event.type === "click"));
const hold$ = clickOrHold$.pipe(filter((event) => event.type === "hold"));
const DOUBLE_CLICK_INTERVAL = 200;
const clickOrDoubleClick$ = click$.pipe(
buffer(click$.pipe(switchMap(() => timer(DOUBLE_CLICK_INTERVAL)))),
map((clicksArr) =>
clicksArr.length > 1 ? createDoubleClick() : createClick()
)
);
const doubleClick$ = clickOrDoubleClick$.pipe(
filter(({ type }) => type === "doubleClick")
);
export const gestures$ = merge(hold$, clickOrDoubleClick$);
والآن لنرَ كيف يمكن استخدام هذه التدفقات داخل تطبيق. أنشأتُ مشروع Vite جديدًا من قالب React وTypescript وغيّرتُ App.tsx على النحو التالي:
import "./App.css";
import { downSubject, gestures$, upSubject } from "./gestures";
gestures$.subscribe((gesture) => {
console.log(gesture);
});
function App() {
return (
<div className="App">
<button
onMouseDown={() => {
downSubject.next({ type: "down" });
}}
onMouseUp={() => {
upSubject.next({ type: "up" });
}}
>
Button
</button>
</div>
);
}
export default App;
تمرين للقارئ
إليك تحديًا يساعدك على التدرب على ما غطيناه اليوم.
ابنِ ClickStreak$، وهو تدفق يبث أرقامًا (للتبسيط) ويتصرف على النحو التالي:
- عندما ينقر المستخدم زرًا n مرة، وتأتي كل نقرة خلال 200 مللي ثانية من سابقتها، يبث التدفق n.
فإذا نقر شخص ما زرًا مرة واحدة ثم توقف 0.2 ثانية، يُبَثّ 1. وإذا نقره 17 مرة بتتابع سريع، لا يُبَثّ سوى الرقم 17، وهكذا.
إضافي: آلات الحالة
مع أن تنفيذنا القائم على التدفقات أفضل بكثير من شيفرة السباغيتي الأمرية المعتادة المحشوة بعبارات if والمتغيرات وsetTimeouts، فهناك نهج آخر قد يكون أفضل: آلات الحالة.
لن أتعمق في آلات الحالة إن لم تكن قد صادفتها، لكن باختصار، نصف نظامنا بوصفه مجموعة كل الحالات التي يمكن أن يكون فيها وكل الانتقالات الممكنة بين تلك الحالات، وهي انتقالات تُطلَق عادةً بواسطة أحداث.
فيما يلي مخطط يوضح كيف يمكن نمذجة نظامنا كآلة حالة:

- نبدأ في حالة اسمها
default، والانتقال الوحيد الممكن منها هو إلىafterDown، بحدثdown. - عند دخول
afterDownنبدأ مؤقتًا داخليًا مدته 500 مللي ثانية يعيدنا إلىdefaultويبث حدثhold. لكن المؤقت يُهمَل إذا غادرنا تلك الحالة. - ومن ثم، إذا وصل حدث
upونحن في حالةafterDown، ننتقل إلىafterClick. - عند دخول
afterClickنبدأ مؤقتًا ثانيًا مدته 200 مللي ثانية، يعيدنا إلى default ويبثclick. - أما إذا وصل حدث
downقبل انتهاء ذلك المؤقت، فننتقل إلىdefaultمع حدثdoubleClickبدلًا من ذلك.
وهكذا يمكن تنفيذه باستخدام xstate، وهي مكتبة آلات حالة واسعة الاستخدام لـ JavaScript وTypescript:
import { createMachine } from "xstate";
const timer = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
export const gesturesMachine = createMachine({
schema: {
events: {} as { type: "UP" } | { type: "DOWN" },
},
initial: "default",
states: {
default: {
on: {
DOWN: "afterDown",
},
},
afterDown: {
on: {
UP: "afterClick",
},
invoke: {
src: () => timer(500),
onDone: {
target: "default",
actions: () => console.log("hold"),
},
},
},
afterClick: {
on: {
UP: {
target: "default",
actions: () => console.log("doubleClick"),
},
},
invoke: {
src: () => timer(200),
onDone: {
target: "default",
actions: () => console.log("click"),
},
},
},
},
});
وهكذا يمكن استخدامه في React:
import "./App.css";
import { useMachine } from "@xstate/react";
import { gesturesMachine } from "./stateMachine";
function App() {
const [_current, send] = useMachine(gesturesMachine);
return (
<div className="App">
<button
onMouseDown={() => {
send("DOWN");
}}
onMouseUp={() => {
send("UP");
}}
>
State Machine Button
</button>
</div>
);
}
export default App;
أحسنت، لقد وصلت إلى النهاية! آمل أن يكون هذا الدليل القصير قد ألهمك قليلًا. وإن كانت لديك أفكار أو تجربة خاصة في بناء تدفقات مفيدة باستخدام RxJS، فلا تتردد في إخبارنا بها في تعليق 🙏🏻