@riishabh/react-calender-heatmap 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Rishabh Sharma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# TileChart Component
+
+The `TileChart` is a React component that displays data in a tile format, where each tile represents a day. The color of the tile indicates the status of that day, which can be "success", "warning", or "alert".
+
+## Props
+
+- `data`: An array of objects, where each object represents a day and has a `date` and a `status`. The `date` is a string in ISO format, and the `status` can be "success", "warning", or "alert".
+- `range`: The number of months to display. It can be 3, 6, or 12. The default is 6.
+- `onTileHover`: A callback function that is called when a tile is hovered over. It receives the date and status of the hovered tile.
+- `tileText`: A string that is displayed on each tile.
+
+## Usage
+
+```tsx
+import TileChart from './TileChart';
+
+const data = [
+  { date: '2022-01-01T00:00:00.000Z', status: 'success' },
+  { date: '2022-01-02T00:00:00.000Z', status: 'warning' },
+  // More data...
+];
+
+function App() {
+  return (
+    <TileChart
+      data={data}
+      range={6}
+      onTileHover={(date, status) => console.log(date, status)}
+      tileText="Day"
+    />
+  );
+}
+
+export default App;