react拖曳組件react-dnd的簡單封裝使用

分享原因

由于項目中需要使用拖曳組件(需求:全局因妙,跨組件痰憎,跨數(shù)據(jù)),我選擇了react-dnd

概念

React DnD 是一組 React 高階組件兰迫,我們在使用的時候只需要將目標(biāo)元素進(jìn)行包裹信殊,就可以實現(xiàn)目標(biāo)元素具有拖動或接受拖動的功能。它將整個拖動的事件完整的描述了出來汁果,這使得我們在使用的過程變得簡單易用和擴展上有了無限的可能涡拘,在處理復(fù)雜拖曳和豐富需求的時候強烈建議使用它。
官網(wǎng) https://react-dnd.github.io/react-dnd/

基本

  • Item type:跟redux或其他組件一樣据德,item用來描述拖動dom的數(shù)據(jù)對象跷车,type用來標(biāo)識一組可拖動和接收
  • Backend:用來表現(xiàn)dom拖動現(xiàn)象,我使用了HTML5Backend
  • Monitors:用來查詢當(dāng)前拖動狀態(tài)(數(shù)據(jù)橱野,dom朽缴,位置等),強大的收集功能
  • Connectors:用于Backend和組件狀態(tài)之間的連接
  • hook:useDrag 將組件作為可拖動的來源注冊到dnd useDrop 將組件作為可接收拖動來源注冊到dnd

使用方法

導(dǎo)入
npm install react-dnd react-dnd-html5-backend
初始化

import { HTML5Backend } from 'react-dnd-html5-backend';
 <DndProvider backend={HTML5Backend}>
     ....
 </>

組件參數(shù)type.ts

export type DragProps = {
    name: string; //名稱標(biāo)記
    type: string; //暫用于標(biāo)記拖拽類型,接收者和發(fā)送者一致
    role: string; //
    data: any; //綁定的數(shù)據(jù)用于拖曳后操作數(shù)據(jù)
    content: JSX.Element; //綁定的元素
    onDragFinished: Function; //拖動結(jié)束回調(diào).
};

export type AcceptorProps = {
    name: string; //名稱標(biāo)記
    type: string; //暫用于標(biāo)記拖拽類型,接收者和發(fā)送者一致
    role: string; //
    data: any; //綁定的數(shù)據(jù)用于拖曳后操作數(shù)據(jù)
    content: JSX.Element; //綁定的元素
    styleType: 'background' | 'border';
    // customStyle:{
    //     canDrop:string,
    //     isActive:string
    // }
    onHover: Function; //移入?yún)^(qū)域.
};

組件MyDrag.ts

import { useDrag, useDrop } from 'react-dnd';
import { DragProps, AcceptorProps } from './type';
export const Dragger = function Dragger(option: DragProps) {
    const { name, data, type, onDragFinished } = option;
    const [{ isDragging }, drag] = useDrag(() => ({
        type: type,
        item: { name: name, data: data },
        end: (item, monitor, ...arg) => {
            console.log(arg);
            const dropResult = monitor.getDropResult();
            if (item && dropResult) {
                console.log('source:', item);
                console.log('target:', dropResult);
            }
            if (onDragFinished) {
                onDragFinished(item, dropResult);
            }
        },
        collect: (monitor) => ({
            isDragging: monitor.isDragging(),
            handlerId: monitor.getHandlerId(),
        }),
    }));
    const opacity = isDragging ? 0.4 : 1;
    return (
        <div
            ref={drag}
            role={option.role}
            style={{ opacity }}
            data-id={`${option.name}`}
        >
            {option.content}
        </div>
    );
};
export const Acceptor = (option: AcceptorProps) => {
    const { name, data, type, styleType, onHover } = option;
    const [{ canDrop, isOver }, drop] = useDrop(() => ({
        accept: type,
        drop: () => option,
        hover: () => {
            if (onHover) {
                onHover();
            }
        },
        collect: (monitor) => ({
            isOver: monitor.isOver(),
            canDrop: monitor.canDrop(),
        }),
    }));
    const isActive = canDrop && isOver;
    let backgroundColor = '#222';
    let borderBottom = '0px solid rgba(31, 92, 206, 0)';
    if (isActive) {
        backgroundColor = 'rgba(64, 224, 208, 0.3)';
        borderBottom = '1px solid #26BD11';
    } else if (canDrop) {
        backgroundColor = 'rgba(100, 149, 277, 0.3)';
        borderBottom = '1px solid #2063AF';
    }
    return (
        <div
            ref={drop}
            role={'Acceptor'}
            style={
                styleType === 'background'
                    ? { backgroundColor }
                    : { borderBottom }
            }
        >
            {option.content}
        </div>
    );
};
//同一list之間拖動
export const dragList = (
    list: Array<any>,
    crtIndex: number,
    willIndex: number,
) => {
    let targetItem = list[crtIndex];
    let delIndex = crtIndex < willIndex ? crtIndex : crtIndex + 1;
    list.splice(willIndex, 0, targetItem);
    list.splice(delIndex, 1);

    return list;
};
//來自不同list之間拖動水援,1.刪除原來  2不刪除原來
export const dragToList = (
    list: Array<any>,
    targetList: Array<any>,
    crtIndex: number,
    willIndex: number,
    del: 1 | 2,
) => {
    let targetItem = list[crtIndex];
    targetList.splice(willIndex, 0, targetItem);
    if (del === 1) {
        list.splice(crtIndex, 1);
    }

    return { list, targetList };
};

具體使用

import { Dragger, Acceptor, dragList } from '@/components/Drag';
//同列表之間拖曳
 handleDrag(crt: number, target: number) {
      conslog.log(dragList(newPanels, crt, target);)
    }
 renderDrag(item: ItemProps, children) {
    <Acceptor
                    key={item.type}
                    name={item.title}
                    data={item}
                    type="xxx"
                    role="xxxAccept"
                    onHover={() => {}}
                    content={
                        <Dragger
                            name={item.title}
                            data={item}
                            type="xxx"
                            role="xxxDrag"
                            content={children}
                            onDragFinished={(source: any, target: any) => {
                                console.log(source, target, '回調(diào)');
                                if (target) {
                                    this.handleDrag(
                                        source.data.sort,
                                        target.data.sort,
                                    );
                                }
                            }}
                        />
                    }
                    styleType="border"
                />
                
       }
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末密强,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子蜗元,更是在濱河造成了極大的恐慌或渤,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,378評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件奕扣,死亡現(xiàn)場離奇詭異薪鹦,居然都是意外死亡,警方通過查閱死者的電腦和手機惯豆,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,356評論 2 382
  • 文/潘曉璐 我一進(jìn)店門池磁,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人楷兽,你說我怎么就攤上這事地熄。” “怎么了拄养?”我有些...
    開封第一講書人閱讀 152,702評論 0 342
  • 文/不壞的土叔 我叫張陵离斩,是天一觀的道長银舱。 經(jīng)常有香客問我瘪匿,道長,這世上最難降的妖魔是什么寻馏? 我笑而不...
    開封第一講書人閱讀 55,259評論 1 279
  • 正文 為了忘掉前任棋弥,我火速辦了婚禮,結(jié)果婚禮上诚欠,老公的妹妹穿的比我還像新娘顽染。我一直安慰自己,他們只是感情好轰绵,可當(dāng)我...
    茶點故事閱讀 64,263評論 5 371
  • 文/花漫 我一把揭開白布粉寞。 她就那樣靜靜地躺著,像睡著了一般左腔。 火紅的嫁衣襯著肌膚如雪唧垦。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,036評論 1 285
  • 那天液样,我揣著相機與錄音振亮,去河邊找鬼巧还。 笑死,一個胖子當(dāng)著我的面吹牛坊秸,可吹牛的內(nèi)容都是我干的麸祷。 我是一名探鬼主播,決...
    沈念sama閱讀 38,349評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼褒搔,長吁一口氣:“原來是場噩夢啊……” “哼阶牍!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起星瘾,我...
    開封第一講書人閱讀 36,979評論 0 259
  • 序言:老撾萬榮一對情侶失蹤荸恕,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后死相,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體融求,經(jīng)...
    沈念sama閱讀 43,469評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,938評論 2 323
  • 正文 我和宋清朗相戀三年算撮,在試婚紗的時候發(fā)現(xiàn)自己被綠了生宛。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,059評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡肮柜,死狀恐怖陷舅,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情审洞,我是刑警寧澤莱睁,帶...
    沈念sama閱讀 33,703評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站芒澜,受9級特大地震影響仰剿,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜痴晦,卻給世界環(huán)境...
    茶點故事閱讀 39,257評論 3 307
  • 文/蒙蒙 一南吮、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧誊酌,春花似錦部凑、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,262評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至箱锐,卻和暖如春比勉,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評論 1 262
  • 我被黑心中介騙來泰國打工敷搪, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留兴想,地道東北人。 一個月前我還...
    沈念sama閱讀 45,501評論 2 354
  • 正文 我出身青樓赡勘,卻偏偏與公主長得像嫂便,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子闸与,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,792評論 2 345

推薦閱讀更多精彩內(nèi)容

  • 現(xiàn)在有一個新需求就是需要對一個列表毙替,實現(xiàn)拖拽排序的功能,要實現(xiàn)的效果如下圖:? 可以通過 react-dnd 或者...
    sendSnow閱讀 12,750評論 1 2
  • 安裝yarn add react-dnd react-dnd-html5-backend 了解相應(yīng)API Drag...
    Mr君閱讀 8,713評論 3 3
  • 今天與你分享的是 redux 作者 Dan 的另外一個很贊的項目 react-dnd (github 9.6k s...
    binggg_booker閱讀 35,821評論 1 13
  • 優(yōu)勢 1 .遇到一個不能忍受的問題践樱,就是拖拽的時候那個禁止按鈕無法替換厂画。看下這個拖拽組件有什么東西是別的不能替代的...
    skoll閱讀 21,256評論 0 2
  • 前言 前面文章中我寫過 react-smooth-dnd 的拖拽拷邢,它是基于 React DnD 庫實現(xiàn)袱院,將 Rea...
    arial_1df2閱讀 12,963評論 3 4