chore: prepare for major release

Author: jvllmr

.eslintrc.cjs

@@ -7,7 +7,7 @@ module.exports = {
     "plugin:react-hooks/recommended",
     "plugin:storybook/recommended",
   ],
-  ignorePatterns: ["dist", ".eslintrc.cjs"],
+  ignorePatterns: ["dist", ".eslintrc.cjs", "build"],
   parser: "@typescript-eslint/parser",
   plugins: ["react-refresh"],
   rules: {

.github/workflows/npm-publish.yaml

@@ -6,6 +6,7 @@ name: Publish package
 on:
   release:
     types: [created]
+  workflow_dispatch:
 
 jobs:
   build:

.pre-commit-config.yaml

@@ -1,6 +1,7 @@
 ci:
   skip:
     - prettier
+    - eslint
 repos:
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v3.1.0
@@ -9,3 +10,10 @@ repos:
         additional_dependencies:
           - prettier@latest
           - prettier-plugin-organize-imports@latest
+  - repo: local
+    hooks:
+      - id: eslint
+        name: Lint with eslint
+        pass_filenames: false
+        language: system
+        entry: pnpm lint

README.md

@@ -2,18 +2,109 @@
 
 A simple but customizable resource scheduler/timeline built with mantine
 
-Compatibility:
-This library uses subgrids, which are a brand new feature in browsers (most released a supporting version in July 2024), for creating its layout.
-Read here about its browser compatibility: https://caniuse.com/css-subgrid
+## Compatibility:
 
-It uses the following peer dependencies:
+This library uses subgrids, which is a rather new browser feature.
+
+## Peer dependencies
 
 - `@mantine/hooks` for @mantine/core
 - `@mantine/core` for styling
 - `dayjs` for handling of dates
-- `@tanstack/react-virtual` for virtualization
+- `@tanstack/react-virtual` for virtualization of bigger timelines
+- `valtio` for more granular render control
+- `@use-gesture/react` for panning and zoom gestures when holding CTRL
+
+## Minimal usage
+
+```tsx
+import { type Dayjs } from "dayjs";
+import { useSchedulerController, Scheduler } from "mantine-resource-timeline";
+
+interface MyDataType {
+  id: string | number;
+  resourceId: string | number | number[] | string[];
+  startDate: Date;
+  endDate: Date;
+}
+
+interface MyResourceType {
+  id: string | number;
+  name: string;
+}
+
+const data: MyDataType[] = [
+  {
+    id: "appointment-1",
+    title: "Bob & Alice Meet",
+    resourceId: [1, 2],
+    startDate: Dayjs,
+    endDate: Dayjs,
+  },
+];
+
+const resources: MyResourceType[] = [
+  {
+    id: 1,
+    name: "Bob",
+  },
+  {
+    id: 2,
+    name: "Alice",
+  },
+];
+
+function MyTimeline() {
+  const controller = useSchedulerController<MyDataType, MyResourceType>({});
+
+  return (
+    <Scheduler
+      controller={controller}
+      data={data}
+      resources={resources}
+      width="100%"
+      height="95vh"
+      dataResourceIdAccessor="resourceId"
+      endDateAccessor="endDate"
+      startDateAccessor="startDate"
+      dataIdAccessor="id"
+      resourceIdAccessor="id"
+      tz="Europe/Berlin"
+    />
+  );
+}
+```
+
+For how to activate other features of this library and adapting the timeline component to your needs take a look at the [Advanced Example](https://github.com/jvllmr/mantine-resource-timeline/blob/dev/stories/Advanced.stories.tsx).
+
+The controller object allows us to control multiple components state, such as the time to be displayed, from the outside. It's a valtio proxy object which allows us to pass it around in our app without having to fear unnecessary re-renders. Take a look at [valtio's documentation](https://valtio.dev/docs/introduction/getting-started) to find out how a valtio proxy object is handled correctly.
+
+## Future development
+
+I have mostly achieved what I initially wanted to achieve with this component library. This means I most likely won't re-iterate on it because I have lost mostly lost my interest in this project.
+I'm still eager to answer questions via issues or review Pull Requests to this project though. Feel free to contribute anything you'd like as long as it's within the scope of this project. Especially if it includes documentation/tests.
+
+## Contributing
+
+To develop code for this project you need pnpm. If you don't use pnpm already, you can follow their [installation guide](https://pnpm.io/installation) to install it. I personally recommend installation via corepack.
+
+After that you can install dependencies via:
+
+```shell
+pnpm install
+```
+
+Next you should be able to start the storybook server via:
+
+```shell
+pnpm storybook
+```
+
+Then you can open the storybook via http://127.0.0.1:6006.
 
-Roadmap:
+Before committing and pushing you should format and lint the project via the following commands:
 
-- More examples and minimal documentation in Storybook
-- Tests, tests, tests
+```shell
+pnpm format
+pnpm lint
+```

package.json

@@ -2,7 +2,7 @@
   "name": "mantine-resource-timeline",
   "description": "A resource timeline component built with Mantine",
   "private": false,
-  "version": "0.2.0",
+  "version": "7.0.0",
   "type": "module",
   "repository": {
     "url": "git+https://github.com/jvllmr/mantine-resource-timeline.git",
@@ -22,7 +22,8 @@
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview",
     "storybook": "storybook dev -p 6006",
-    "build-storybook": "storybook build"
+    "build-storybook": "storybook build",
+    "format": "prettier -w ."
   },
   "files": [
     "build",

src/controller/controller.ts

@@ -104,7 +104,6 @@ function clipStartViewDate(date: Dayjs, displayUnit: SchedulerDisplayUnit) {
   }
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function calculateDisplayUnit(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   controller: SchedulerController<any, any>,