/dnd-timeline

dnd-timeline: A headless timeline library for React, based on dnd-kit

Primary LanguageTypeScriptMIT LicenseMIT

Screenshot 2024-03-09 at 0 28 29

🎉 dnd-timeline

dnd-timeline: A headless timeline library, based on dnd-kit

  • Headless: dnd-timeline is a headless-ui library, and contains 0 styling, aside from functional styling (position, z-index, etc.).
  • Hook-based: exposes simple hooks like useItem and useRow, that should integrate seamlessly into your existing architecture.
  • Flexible: very slim and flexible by design. dnd-timeline exposes utility functions and positional styling, and you can use them in conjunction with you favorite libraries - styling libraries (MUI, tailwindcss, ant-design, etc.), and functional libraries (react-virtual, framer-motion, etc.)
  • Based on dnd-kit: all features exposed by the dnd-kit library are applicable to dnd-timeline.
  • Performant: renders only when needed. All the intermediate states and animations are done using css transformations, and require 0 re-renders.
  • RTL: dnd-timeline nativly supports RTL. simply declare one of the parent divs as rtl with dir="rtl", and thats it.

2024-03-09 00 35 27

Installation

The library requires a single peer-dependency: react

To install it, run:

npm install react

Then, you can install the library itself:

npm install dnd-timeline

Features

  • Stacked rows: Items whose relevance's intersect are stacked on top of each other inside the same row.
  • Snap to Grid: Items snap into a pre-defined grid when dropped, that can be changed according to zoom level.
  • Time Axis: An optional time axis can be displayed, with different markers according to zoom level.
  • Time Cursor: An optional time cursor indicating the current time on top of the timeline.
  • Pan and zoom: You can zoom by holding Ctrl and scrolling using the mouse wheel, and pan by holding Ctrl + Shift scrolling using the mouse wheel. 2023-07-09 20 27 50
  • Dynamically disabled rows and items: Items and Rows can be disabled according to a client-defined logic. 2023-07-09 20 29 15
  • Integration with external DnD: The timeline can be used in conjunction with other DnD interactions in you app, to drag items into and outside of the timeline. 2023-07-09 20 30 25

Contribute

This project uses turborepo to manage the monorepo. It also uses pnpm instead of npm as a package manager.

To install pnpm, you can run:

corepack enable pnpm

If you want to develop on your local machine, simply clone the project, and run

pnpm install
pnpm run dev

And all the examples will run on your local machine, likned to the local instance of the library. Any changes made to the library will be reflected in the examples.

If you want to run only a specific example, checkout turborepo's --filter operator:

pnpm run dev --filter home...

For example this will run the home package and all the packages' it is depending on (dnd-timeline).