@kashifsaadat/react-scheduler 0.0.8

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Bitnoise
+
+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/dist/index.d.ts

@@ -0,0 +1,160 @@
+import { JSX } from 'react/jsx-runtime';
+
+declare const allZoomLevel: readonly [0, 1, 2];
+
+declare type ColorType = "background" | "gridBackground" | "primary" | "secondary" | "tertiary" | "textPrimary" | "textSecondary" | "accent" | "disabled" | "border" | "placeholder" | "warning" | "button" | "tooltip" | "defaultTile" | "hover";
+
+export declare type Config = {
+    zoom: ZoomLevel;
+    /**
+     * Dictates filter button behavior
+     * - `< 0` - filter button is hidden
+     * - `0` - filter button is visible, no filter had been applied
+     * - `> 0` - filter button visible - filters had been applied
+     */
+    filterButtonState?: number;
+    /**
+     * Language code: "en" | "pl" | "de"
+     */
+    lang?: LangCodes | string;
+    isFiltersButtonVisible?: boolean;
+    maxRecordsPerPage?: number;
+    /**
+     * property for changing behavior of showing tooltip hours
+     * true - will show taken hours same as business days
+     * false - will always show 0 taken hours on weekends in day view
+     * @default false
+     */
+    includeTakenHoursOnWeekendsInDayView?: boolean;
+    /**
+     * show tooltip when hovering over tiles items
+     * @default true
+     */
+    showTooltip?: boolean;
+    translations?: LocaleType[];
+    /**
+     * show toggle button for changing theme (light/dark)
+     */
+    showThemeToggle?: boolean;
+    /**
+     * default theme (light/dark)
+     * when theme toggle is displayed - this is a default value of the toggle
+     * @default "light"
+     */
+    defaultTheme?: "light" | "dark";
+    theme?: Theme;
+    minZoom?: (typeof allZoomLevel)[number];
+    maxZoom?: (typeof allZoomLevel)[number];
+    dateFormat?: string;
+    timeFormat?: string;
+};
+
+declare type LangCodes = "en" | "pl" | "de" | "lt";
+
+declare type LocaleType = {
+    id: string;
+    lang: Translation;
+    translateCode: string;
+    dayjsTranslations: string | ILocale | undefined;
+};
+
+declare type ParsedDatesRange = {
+    startDate: Date;
+    endDate: Date;
+};
+
+export declare const Scheduler: ({ data, config, startDate, onRangeChange, onTileClick, onFilterData, onClearFilterData, onItemClick, isLoading }: SchedulerProps) => JSX.Element;
+
+export declare type SchedulerData = SchedulerRow[];
+
+declare type SchedulerItemClickData = Omit<SchedulerRow, "data">;
+
+export declare type SchedulerProjectData = {
+    /**
+     * Unique Id of item
+     */
+    id: string;
+    /**
+     * Represents start date of from which tile will render
+     */
+    startDate: Date;
+    /**
+     * Represents end date to which tile will render
+     */
+    endDate: Date;
+    /**
+     * Indicates how much time is spent per day. Given in seconds and converted by Scheduler to hours/minutes
+     */
+    occupancy: number;
+    /**
+     * Title of item
+     */
+    title: string;
+    /**
+     * Subtitle of item. Optional
+     */
+    subtitle?: string;
+    /**
+     * Short description displayed on tile. Optional
+     */
+    description?: string;
+    /**
+     * Background color of the tile, given in rgb color model. If not given, default color (rgb(114, 141,226 )) is set. Optional
+     */
+    bgColor?: string;
+};
+
+export declare type SchedulerProps = {
+    data: SchedulerData;
+    isLoading?: boolean;
+    config?: Config;
+    startDate?: string;
+    onRangeChange?: (range: ParsedDatesRange) => void;
+    onTileClick?: (data: SchedulerProjectData) => void;
+    onFilterData?: () => void;
+    onClearFilterData?: () => void;
+    onItemClick?: (data: SchedulerItemClickData) => void;
+};
+
+declare type SchedulerRow = {
+    id: string;
+    label: SchedulerRowLabel;
+    data: SchedulerProjectData[];
+};
+
+declare type SchedulerRowLabel = {
+    icon: string;
+    title: string;
+    subtitle: string;
+};
+
+declare type Theme = {
+    light?: Partial<Record<ColorType, string>>;
+    dark?: Partial<Record<ColorType, string>>;
+};
+
+declare type Topbar = {
+    filters: string;
+    next: string;
+    prev: string;
+    today: string;
+    view: string;
+};
+
+declare type Translation = {
+    feelingEmpty: string;
+    free: string;
+    loadNext: string;
+    loadPrevious: string;
+    over: string;
+    taken: string;
+    topbar: Topbar;
+    search: string;
+    week: string;
+};
+
+export declare type ZoomLevel = ZoomLevelTuple[number];
+
+declare type ZoomLevelTuple = typeof allZoomLevel;
+
+export { }