mumineen-ui-plugins 1.5.0 → 1.7.0

package/README.md

@@ -1,62 +1,39 @@
-# Mumineen Calendar
+# Mumineen UI Plugins
 
-## Introduction
-
-Mumineen Calendar is a [Hijri calendar] for [Dawoodi Bohra Shia Muslims] who
-follow the 53rd Dai al-Mutlaq, His Holiness, [Syedna Aale Qadr Mufaddal
-Saifuddin] (_TUS_). It provides the user with the Hijri date, [Gregorian date]
-for any day of the calendar year.
-
-This version is primarily written in JavaScript using [React] and [Middleman].
-It supercedes the [Ruby on Rails version] I wrote some time ago.
-
-[Dawoodi Bohra Shia Muslims]: https://www.thedawoodibohras.com/
-[Gregorian date]: http://en.wikipedia.org/wiki/Gregorian_calendar
-[Hijri Calendar]: http://en.wikipedia.org/wiki/Islamic_calendar
-[Middleman]: http://middlemanapp.com/
-[React]: http://facebook.github.io/react/
-[Ruby on Rails version]: https://github.com/mygulamali/mumineen_calendar
-[Syedna Aale Qadr Mufaddal Saifuddin]: https://www.thedawoodibohras.com/about-the-bohras/the-dai-al-mutlaq/53rd-dai-al-mutlaq/
-
-## Setup
+Mumineen UI Plugins is a react library which features some of the commonly used UI plugins
+for [Dawoodi Bohra Shia Muslims] who follow the 53rd Dai al-Mutlaq, His Holiness, [Syedna Aale Qadr Mufaddal
+Saifuddin] (_TUS_).
 
+## Installation
 ```shell
-git clone git@github.com:mygulamali/mumineen_calendar_js
-cd mumineen_calendar_js
-bundle install
-cp .env.example .env
-cd source/assets/stylesheets
-bundle exec bourbon install
-bundle exec neat install
+npm install mumineen-ui-plugins
+```
+or
+```shell
+yarn add mumineen-ui-plugins
 ```
 
-Then complete the variables in the `.env` file for you environment.  The current
-values can be found in the _Build & deploy_ section under the _Site settings_
-tab for the website, on Netlify.
-
-## Serve on your localhost
-
-`bundle exec middleman`
-
-Then visit `http://localhost:4567` to see the site in action.
-
-## Deploy to your web server
-
-`bundle exec middleman deploy`
-
-This command will automagically commit the built website to the correct branch
-of this repo for your static site server (i.e. [GitHub Pages] or [Netlify])
-to serve.
-
-[Netlify]: https://www.netlify.com/ "Netlify"
-[GitHub Pages]: https://pages.github.com/ "GitHub Pages"
-
-## Testing
+This package only contains one UI plugin which is the [Hijri Calendar] but there will be more plugins added in the future.
 
-After starting the local server (see above), visit
-`http://localhost:4567/jasmine` to run the [Jasmine] specs.
+## Hijri Calendar
+### Usage
+```typescript
+import { HijriCalendar } from 'mumineen-ui-plugins';
 
-[Jasmine]: http://jasmine.github.io/
+const App = () => {
+  return (
+    <HijriCalendar />
+  );
+}
+```
+![img.png](img.png)
+### Props
+| Name | Type       | Default     | Description                                                            |
+| --- |------------|-------------|------------------------------------------------------------------------|
+| `miqaats` | `MiqaatMonth[]` | `[]`        | List of miqaats to be displayed on the calendar.                       |
+| `additionalDayContent` | `(day: Day) => React.ReactNode` | `undefined` | Callback function to return additional content in the modal for a day. |
+| `onDayClick` | `(day: Day) => void` | `undefined` | Callback function to be called when a day is clicked.                  |
+| `showDefaultMiqaatData` | `boolean` | `false`      | Whether to show the default miqaat data (embedded in library).         |
 
 ## License
 
@@ -64,3 +41,10 @@ This software is released under the terms and conditions of [The MIT License].
 Please see the `LICENSE.txt` file for more details.
 
 [The MIT License]: http://www.opensource.org/licenses/mit-license.php
+[Dawoodi Bohra Shia Muslims]: https://www.thedawoodibohras.com/
+[Gregorian date]: http://en.wikipedia.org/wiki/Gregorian_calendar
+[Hijri Calendar]: http://en.wikipedia.org/wiki/Islamic_calendar
+[Middleman]: http://middlemanapp.com/
+[React]: http://facebook.github.io/react/
+[Ruby on Rails version]: https://github.com/mygulamali/mumineen_calendar
+[Syedna Aale Qadr Mufaddal Saifuddin]: https://www.thedawoodibohras.com/about-the-bohras/the-dai-al-mutlaq/53rd-dai-al-mutlaq/

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export { MiqaatList } from "./hijri-calendar/MiqaatList";
 export { Day } from "./hijri-calendar/libs/HijriCalendar";
 export { MiqaatMonth, Miqaat } from "./hijri-calendar/HijriCalender.interface";
 export { getGregorianDate, getHijriDate } from "./hijri-calendar/utils";
+export { QasrNamaaz } from "./qasr/QasrNamaaz";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHijriDate = exports.getGregorianDate = exports.MiqaatList = exports.HijriCalendar = void 0;
+exports.QasrNamaaz = exports.getHijriDate = exports.getGregorianDate = exports.MiqaatList = exports.HijriCalendar = void 0;
 var CalendarFrame_1 = require("./hijri-calendar/CalendarFrame");
 Object.defineProperty(exports, "HijriCalendar", { enumerable: true, get: function () { return CalendarFrame_1.CalendarFrame; } });
 var MiqaatList_1 = require("./hijri-calendar/MiqaatList");
@@ -8,3 +8,5 @@ Object.defineProperty(exports, "MiqaatList", { enumerable: true, get: function (
 var utils_1 = require("./hijri-calendar/utils");
 Object.defineProperty(exports, "getGregorianDate", { enumerable: true, get: function () { return utils_1.getGregorianDate; } });
 Object.defineProperty(exports, "getHijriDate", { enumerable: true, get: function () { return utils_1.getHijriDate; } });
+var QasrNamaaz_1 = require("./qasr/QasrNamaaz");
+Object.defineProperty(exports, "QasrNamaaz", { enumerable: true, get: function () { return QasrNamaaz_1.QasrNamaaz; } });