@gfazioli/mantine-clock 1.0.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+ionut.florescu@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing
+
+👏 Thank you for considering contributing to this project.
+
+## Bug Reports
+
+When encountering issues with software or applications, submitting a detailed bug report can significantly help developers in understanding and resolving the problem efficiently. A well-written bug report should include clear steps to reproduce the issue, the expected behavior, and the actual outcome. 
+
+Furthermore, providing information such as system specifications, error messages, and screenshots can aid in pinpointing the root cause of the bug. By utilizing platforms like GitHub, users can create issue tickets with relevant details, facilitating effective communication between users and developers. Remember, a comprehensive bug report not only assists in bug resolution but also improves the overall quality of the software.
+
+🐛 [GitHub issue](https://github.com/gfazioli/mantine-clock/issues)
+
+
+## Code contributors
+
+Here's a list of all the people who have contributed to the codebase of this project so far:
+
+[![Contributors list](https://contrib.rocks/image?repo=gfazioli/mantine-clock)](https://github.com/gfazioli/mantine-clock/graphs/contributors)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Giovambattista Fazioli
+
+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,228 @@
+# Mantine Clock Component
+
+https://github.com/user-attachments/assets/727a8634-28ee-4279-80b1-dcf2cb7f5961
+
+---
+
+<div align="center">
+  
+  [![NPM version](https://img.shields.io/npm/v/%40gfazioli%2Fmantine-clock?style=for-the-badge)](https://www.npmjs.com/package/@gfazioli/mantine-clock)
+  [![NPM Downloads](https://img.shields.io/npm/dm/%40gfazioli%2Fmantine-clock?style=for-the-badge)](https://www.npmjs.com/package/@gfazioli/mantine-clock)
+  [![NPM Downloads](https://img.shields.io/npm/dy/%40gfazioli%2Fmantine-clock?style=for-the-badge&label=%20&color=f90)](https://www.npmjs.com/package/@gfazioli/mantine-clock)
+  ![NPM License](https://img.shields.io/npm/l/%40gfazioli%2Fmantine-clock?style=for-the-badge)
+
+</div>
+
+## Overview
+
+This component is created on top of the [Mantine](https://mantine.dev/) library.
+
+[![Mantine UI Library](https://img.shields.io/badge/-MANTINE_UI_LIBRARY-blue?style=for-the-badge&labelColor=black&logo=mantine
+)](https://mantine.dev/)
+
+It provides the capability to generate a dynamic clock effect, enabling the display of a wide variety of content in a visually engaging manner. This effect can enhance the overall user experience by drawing attention to important information, announcements, or promotions, allowing for a more interactive and captivating presentation.
+
+[![Mantine Extensions](https://img.shields.io/badge/-Watch_the_Video-blue?style=for-the-badge&labelColor=black&logo=youtube
+)](https://www.youtube.com/playlist?list=PL85tTROKkZrWyqCcmNCdWajpx05-cTal4)
+[![Demo and Documentation](https://img.shields.io/badge/-Demo_%26_Documentation-blue?style=for-the-badge&labelColor=black&logo=typescript
+)](https://gfazioli.github.io/mantine-clock/)
+[![Mantine Extensions HUB](https://img.shields.io/badge/-Mantine_Extensions_Hub-blue?style=for-the-badge&labelColor=blue
+)](https://mantine-extensions.vercel.app/)
+
+👉 You can find more components on the [Mantine Extensions Hub](https://mantine-extensions.vercel.app/) library.
+
+
+## Installation
+
+```sh
+npm install @gfazioli/mantine-clock
+```
+or 
+
+```sh
+yarn add @gfazioli/mantine-clock
+```
+
+After installation import package styles at the root of your application:
+
+```tsx
+import '@gfazioli/mantine-clock/styles.css';
+```
+
+## Usage
+
+The Mantine Clock library provides powerful components and hooks for time management and visualization in React applications using Mantine.
+
+### Clock Component
+
+Create analog clocks with real-time updates or static time display:
+
+```tsx
+import { Clock } from '@gfazioli/mantine-clock';
+
+// Real-time clock
+function LiveClock() {
+  return <Clock />;
+}
+
+// Static clock showing specific time
+function StaticClock() {
+  return <Clock value={new Date('2023-12-25T15:30:00')} running={false} />;
+}
+
+// Customized clock with timezone
+function WorldClock() {
+  return (
+    <Clock 
+      timezone="America/New_York"
+      showNumbers
+      size={200}
+      hourHandColor="blue"
+      minuteHandColor="cyan"
+      secondHandColor="red"
+    />
+  );
+}
+```
+
+### useClock Hook
+
+Get real-time time data with flexible formatting:
+
+```tsx
+import { useClock } from '@gfazioli/mantine-clock';
+
+function DigitalClock() {
+  const { hours, minutes, seconds, amPm, isRunning } = useClock({
+    timezone: 'UTC',
+    use24Hours: false,
+    padHours: true,
+    padMinutes: true,
+    padSeconds: true
+  });
+
+  return (
+    <div>
+      {hours}:{minutes}:{seconds} {amPm}
+    </div>
+  );
+}
+```
+
+### useClockCountDown Hook
+
+Create countdown timers with target dates or durations:
+
+```tsx
+import { useClockCountDown } from '@gfazioli/mantine-clock';
+
+// Countdown to specific date
+function EventCountdown() {
+  const { day, hours, minutes, seconds } = useClockCountDown({
+    targetDate: new Date('2024-12-31T23:59:59'),
+    onCountDownCompleted: () => alert('Happy New Year!')
+  });
+
+  return (
+    <div>
+      Time remaining: {day}d {hours}h {minutes}m {seconds}s
+    </div>
+  );
+}
+
+// Countdown from duration
+function TimerCountdown() {
+  const { minutes, seconds, isRunning } = useClockCountDown({
+    minutes: 25, // 25-minute Pomodoro timer
+    onCountDownCompleted: () => console.log('Break time!')
+  });
+
+  return (
+    <div>
+      Pomodoro: {minutes}:{seconds}
+    </div>
+  );
+}
+```
+
+### Styling and Theming
+
+The library integrates seamlessly with Mantine's theming system:
+
+```tsx
+import '@gfazioli/mantine-clock/styles.css';
+// or with CSS layers
+import '@gfazioli/mantine-clock/styles.layer.css';
+
+// Custom styled clock
+function ThemedClock() {
+  return (
+    <Clock 
+      style={{
+        '--clock-bg': 'var(--mantine-color-blue-1)',
+        '--clock-border': 'var(--mantine-color-blue-6)'
+      }}
+      className="my-custom-clock"
+    />
+  );
+}
+```
+
+### Advanced Examples
+
+```tsx
+// Multi-timezone dashboard
+function WorldClockDashboard() {
+  const timezones = [
+    { name: 'New York', tz: 'America/New_York' },
+    { name: 'London', tz: 'Europe/London' },
+    { name: 'Tokyo', tz: 'Asia/Tokyo' }
+  ];
+
+  return (
+    <div style={{ display: 'flex', gap: '2rem' }}>
+      {timezones.map(({ name, tz }) => (
+        <div key={tz}>
+          <h3>{name}</h3>
+          <Clock timezone={tz} size={150} />
+        </div>
+      ))}
+    </div>
+  );
+}
+
+// Countdown with controls
+function ControllableCountdown() {
+  const countdown = useClockCountDown({
+    minutes: 10,
+    enabled: false
+  });
+
+  return (
+    <div>
+      <div>{countdown.minutes}:{countdown.seconds}</div>
+      <button onClick={countdown.start}>Start</button>
+      <button onClick={countdown.pause}>Pause</button>
+      <button onClick={countdown.resume}>Resume</button>
+      <button onClick={countdown.reset}>Reset</button>
+    </div>
+  );
+}
+```
+
+## Features
+
+- **Real-time Updates**: Automatic time synchronization with configurable frequency
+- **Timezone Support**: Global timezone compatibility with IANA timezone database
+- **Customizable Styling**: Full control over appearance and theming
+- **TypeScript Support**: Complete type definitions for better developer experience
+- **Accessibility**: Built with WCAG compliance and screen reader support
+- **Performance Optimized**: Efficient updates with minimal re-renders
+- **Responsive Design**: Adapts to different screen sizes automatically
+
+
+<div align="center">
+  
+[![Star History Chart](https://api.star-history.com/svg?repos=gfazioli/mantine-clock&type=Timeline)](https://www.star-history.com/#gfazioli/mantine-clock&Timeline)
+
+</div>