refine-mantine 1.0.0-dev.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Denis Kruschinski <denis.kruschinski@gmail.com>
+
+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,21 @@
+# Refine-Mantine
+
+## Refine Mantine Components
+
+This project provides ready-to-use [Mantine v8](https://mantine.dev/) UI components and utilities built for [Refine v5](https://refine.dev/) applications.
+It aims to accelerate development by offering a collection of prebuilt components such as layouts, CRUD views, tables, buttons, and authentication screens, following both Refine and Mantine best practices.
+
+### Features
+
+* Prebuilt UI components for rapid Refine project development
+* CRUD and layout templates to simplify dashboard and admin tool creation
+* Authentication-ready views for common login and registration flows
+* Composable and easily customizable component design
+* Storybook documentation for previewing and testing components
+
+**Storybook:** [https://kruschid.github.io/refine-mantine/](https://kruschid.github.io/refine-mantine/)
+
+### Project Status
+
+**Early development stage:** The project is actively being developed, and APIs or component structures may change frequently.
+Feedback, suggestions, and contributions are welcome as the project evolves.

package/dist/index.d.ts

@@ -0,0 +1,276 @@
+import { ActionIconProps, AnchorProps, AppShellFooterProps, AppShellHeaderProps, AppShellMainProps, AppShellNavbarConfiguration, AppShellNavbarProps, AppShellProps, AppShellSectionProps, BadgeProps, BoxProps, BreadcrumbsProps, ButtonProps, CardProps, GroupProps, LoadingOverlayProps, NotificationProps, PinInputProps, PopoverProps, ScrollAreaProps, StackProps, TextInputProps } from "@mantine/core";
+import { AuthProvider, AutoSaveIndicatorProps as AutoSaveIndicatorProps$1, BaseRecord, HttpError, LoginFormTypes, NotificationProvider, OAuthProvider, RegisterFormTypes, UseFormProps as UseFormProps$1, UseFormReturnType as UseFormReturnType$1, useMenu, useTranslate } from "@refinedev/core";
+import { IconProps } from "@tabler/icons-react";
+import * as react_jsx_runtime1 from "react/jsx-runtime";
+import { RefineBreadcrumbProps, RefineCreateButtonProps, RefineCrudCreateProps, RefineCrudEditProps, RefineCrudListProps, RefineCrudShowProps, RefineDeleteButtonProps, RefineEditButtonProps, RefineListButtonProps, RefineRefreshButtonProps, RefineSaveButtonProps, RefineShowButtonProps } from "@refinedev/ui-types";
+import React$1, { ReactNode } from "react";
+import { FormValidateInput, UseFormInput, UseFormReturnType as UseFormReturnType$2 } from "@mantine/form";
+import { Column } from "@tanstack/table-core";
+import { UseTableReturnType } from "@refinedev/react-table";
+
+//#region src/components/breadcrumb/Breadcrumb.d.ts
+type BreadcrumbProps = RefineBreadcrumbProps<BreadcrumbsProps>;
+declare const Breadcrumb: React$1.FC<BreadcrumbProps>;
+//#endregion
+//#region src/components/buttons/CreateButton.d.ts
+type CreateButtonProps = RefineCreateButtonProps<{
+  iconProps?: IconProps;
+  anchorProps?: AnchorProps;
+  actionIconProps?: ActionIconProps;
+  buttonProps?: ButtonProps;
+  disabled?: boolean;
+}>;
+declare const CreateButton: React$1.FC<CreateButtonProps>;
+//#endregion
+//#region src/components/buttons/DeleteButton.d.ts
+type DeleteButtonProps = RefineDeleteButtonProps<{
+  iconProps?: IconProps;
+  popoverProps?: PopoverProps;
+  actionIconProps?: ActionIconProps;
+  buttonProps?: ButtonProps;
+  disabled?: boolean;
+}>;
+declare const DeleteButton: React$1.FC<DeleteButtonProps>;
+//#endregion
+//#region src/components/buttons/EditButton.d.ts
+type EditButtonProps = RefineEditButtonProps<{
+  iconProps?: IconProps;
+  anchorProps?: AnchorProps;
+  actionIconProps?: ActionIconProps;
+  buttonProps?: ButtonProps;
+  disabled?: boolean;
+}>;
+declare const EditButton: React$1.FC<EditButtonProps>;
+//#endregion
+//#region src/components/buttons/ListButton.d.ts
+type ListButtonProps = RefineListButtonProps<{
+  iconProps?: IconProps;
+  anchorProps?: AnchorProps;
+  actionIconProps?: ActionIconProps;
+  buttonProps?: ButtonProps;
+  disabled?: boolean;
+}>;
+declare const ListButton: React$1.FC<ListButtonProps>;
+//#endregion
+//#region src/components/buttons/RefreshButton.d.ts
+type RefreshButtonProps = RefineRefreshButtonProps<{
+  iconProps?: IconProps;
+  actionIconProps?: ActionIconProps;
+  buttonProps?: ButtonProps;
+  disabled?: boolean;
+}>;
+declare const RefreshButton: React$1.FC<RefreshButtonProps>;
+//#endregion
+//#region src/components/buttons/SaveButton.d.ts
+type SaveButtonProps = RefineSaveButtonProps<{
+  iconProps?: IconProps;
+  actionIconProps?: ActionIconProps;
+  buttonProps?: ButtonProps;
+  disabled?: boolean;
+}>;
+declare const SaveButton: React$1.FC<SaveButtonProps>;
+//#endregion
+//#region src/components/buttons/ShowButton.d.ts
+type ShowButtonProps = RefineShowButtonProps<{
+  iconProps?: IconProps;
+  actionIconProps?: ActionIconProps;
+  buttonProps?: ButtonProps;
+  disabled?: boolean;
+}>;
+declare const ShowButton: React$1.FC<ShowButtonProps>;
+//#endregion
+//#region src/components/crud/Create.d.ts
+type CreateProps = RefineCrudCreateProps<SaveButtonProps, GroupProps, GroupProps, CardProps, GroupProps, BoxProps>;
+declare const Create: React$1.FC<CreateProps>;
+//#endregion
+//#region src/components/crud/Edit.d.ts
+type EditProps = RefineCrudEditProps<SaveButtonProps, DeleteButtonProps, GroupProps, GroupProps, CardProps, GroupProps, BoxProps, Record<never, never>, RefreshButtonProps, ListButtonProps>;
+declare const Edit: React$1.FC<EditProps>;
+//#endregion
+//#region src/components/crud/List.d.ts
+type ListProps = RefineCrudListProps<CreateButtonProps, GroupProps, CardProps, GroupProps, BoxProps>;
+declare const List: React$1.FC<ListProps>;
+//#endregion
+//#region src/components/crud/Show.d.ts
+type ShowProps = RefineCrudShowProps<GroupProps, GroupProps, CardProps, GroupProps, BoxProps, {}, EditButtonProps, DeleteButtonProps, RefreshButtonProps, ListButtonProps>;
+declare const Show: React.FC<ShowProps>;
+//#endregion
+//#region src/components/layout/Layout.d.ts
+interface LayoutProps {
+  children: ReactNode;
+  shellProps?: AppShellProps;
+  headerProps?: AppShellHeaderProps;
+  navbarProps?: AppShellNavbarProps;
+  navbarConfiguration?: Partial<AppShellNavbarConfiguration>;
+  navbarMenuProps?: AppShellSectionProps;
+  navbarFooterProps?: AppShellSectionProps;
+  mainProps?: AppShellMainProps;
+  hideNavbar?: boolean;
+  footer?: ReactNode;
+  footerProps?: AppShellFooterProps;
+  locales?: LayoutLocale[];
+  renderHeader?: (toggle: () => void) => ReactNode;
+  renderMenu?: (params: ReturnType<typeof useMenu>) => ReactNode;
+  renderIdentity?: <T extends BaseRecord>(identity: T, logout: () => void) => ReactNode;
+}
+interface LayoutLocale {
+  lang: string;
+  label: string;
+  icon?: ReactNode;
+}
+declare const Layout: React.FC<LayoutProps>;
+//#endregion
+//#region src/components/notification/Message.d.ts
+interface MessageProps {
+  undoableTimeout?: number;
+  undoableTime?: number;
+  message: string;
+  description?: string;
+  undoLabel?: string;
+  notificationProps?: NotificationProps;
+  buttonProps?: ButtonProps;
+  actioniconProps?: ActionIconProps;
+  onUndo: () => void;
+}
+declare const Message: React.FC<MessageProps>;
+//#endregion
+//#region src/components/table/ColumnFilter.d.ts
+declare const ColumnFilter: <T extends object>(p: {
+  column: Column<T>;
+}) => react_jsx_runtime1.JSX.Element | null;
+//#endregion
+//#region src/components/table/ColumnSorter.d.ts
+declare const ColumnSorter: <T extends object>(p: {
+  column: Column<T>;
+}) => react_jsx_runtime1.JSX.Element | null;
+//#endregion
+//#region src/components/table/Table.d.ts
+declare const Table: <TData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError>({
+  props
+}: {
+  props: UseTableReturnType<TData, TError>;
+}) => react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/components/notification/AutoSaveIndicator.d.ts
+interface AutoSaveIndicatorProps {
+  status: AutoSaveIndicatorProps$1["status"];
+  badgeProps?: BadgeProps;
+  iconSize?: number;
+}
+declare const AutoSaveIndicator: React$1.FC<AutoSaveIndicatorProps>;
+//#endregion
+//#region src/components/ColorSchemeToggle.d.ts
+declare function ColorSchemeToggle(): react_jsx_runtime1.JSX.Element;
+//#endregion
+//#region src/hooks/useForm.d.ts
+type FormVariableType<TVariables, TTransformed> = ReturnType<NonNullable<UseFormInput<TVariables, (values: TVariables) => TTransformed>["transformValues"]>>;
+type UseFormReturnType<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = Record<string, unknown>, TTransformed = TVariables, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError> = UseFormReturnType$2<TVariables, (values: TVariables) => TTransformed> & {
+  refineCore: UseFormReturnType$1<TQueryFnData, TError, FormVariableType<TVariables, TTransformed>, TData, TResponse, TResponseError>;
+  saveButtonProps: {
+    disabled: boolean;
+    onClick: (e: React$1.PointerEvent<HTMLButtonElement>) => void;
+  };
+};
+type UseFormProps<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = Record<string, unknown>, TTransformed = TVariables, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError> = {
+  refineCoreProps?: UseFormProps$1<TQueryFnData, TError, FormVariableType<TVariables, TTransformed>, TData, TResponse, TResponseError> & {
+    warnWhenUnsavedChanges?: boolean;
+  };
+} & UseFormInput<TVariables, (values: TVariables) => TTransformed> & {
+  /**
+   * Disables server-side validation
+   * @default false
+   * @see {@link https://refine.dev/docs/advanced-tutorials/forms/server-side-form-validation/}
+   */
+  disableServerSideValidation?: boolean;
+};
+declare const useForm: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables extends Record<string, any> = Record<string, any>, TTransformed = TVariables, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError>({
+  refineCoreProps,
+  disableServerSideValidation: disableServerSideValidationProp,
+  ...rest
+}?: UseFormProps<TQueryFnData, TError, TVariables, TTransformed, TData, TResponse, TResponseError>) => UseFormReturnType<TQueryFnData, TError, TVariables, TTransformed, TData, TResponse, TResponseError>;
+//#endregion
+//#region src/hooks/useOtp.d.ts
+type OtpHandler = ReturnType<typeof useOtp>;
+declare const useOtp: () => {
+  isPending: boolean;
+  request: () => Promise<string>;
+  reject: () => void;
+  resolve: (otp: string) => void;
+};
+//#endregion
+//#region src/pages/auth/LoginPage.d.ts
+type TranslateFn = ReturnType<typeof useTranslate>;
+interface LoginArgs {
+  providerName?: string;
+  email?: string;
+  password?: string;
+  otpHandler?: OtpHandler;
+  translate?: TranslateFn;
+  [key: string]: unknown;
+}
+interface OAuthProviderMantine extends OAuthProvider {
+  buttonProps?: ButtonProps;
+}
+type LoginPageProps = {
+  providers?: OAuthProviderMantine[];
+  mutationVariables?: LoginFormTypes;
+  registerLink?: string;
+  forgotPasswordLink?: string;
+  validate?: FormValidateInput<LoginForm>;
+  wrapperProps?: StackProps;
+  scrollAreaProps?: ScrollAreaProps;
+  emailFieldProps?: TextInputProps;
+  passwordFieldProps?: TextInputProps;
+  cardProps?: CardProps;
+  loadingOverlayProps?: LoadingOverlayProps;
+  otpInputProps?: PinInputProps;
+  submitButtonProps?: ButtonProps;
+  cancelButtonProps?: ButtonProps;
+  icon?: ReactNode;
+  title?: ReactNode;
+  otpHandler?: OtpHandler;
+} & ({
+  method: "oauth";
+  providers: OAuthProvider[];
+} | {
+  method: "otp" | "mfa" | "password";
+});
+interface LoginForm {
+  email: string;
+  password: string;
+}
+declare const LoginPage: React.FC<LoginPageProps>;
+//#endregion
+//#region src/pages/auth/RegisterPage.d.ts
+interface RegisterPageProps {
+  withConfirmation?: boolean;
+  mutationVariables?: RegisterFormTypes;
+  loginLink?: string;
+  validate?: FormValidateInput<RegisterForm>;
+  wrapperProps?: StackProps;
+  scrollAreaProps?: ScrollAreaProps;
+  emailFieldProps?: TextInputProps;
+  passwordFieldProps?: TextInputProps;
+  passwordConfirmationFieldProps?: TextInputProps;
+  cardProps?: CardProps;
+  loadingOverlayProps?: LoadingOverlayProps;
+  otpInputProps?: PinInputProps;
+  submitButtonProps?: ButtonProps;
+  cancelButtonProps?: ButtonProps;
+  icon?: ReactNode;
+  title?: ReactNode;
+}
+interface RegisterForm {
+  email: string;
+  password: string;
+  passwordConfirmation: string;
+}
+declare const RegisterPage: React.FC<RegisterPageProps>;
+//#endregion
+//#region src/providers/authProvider.d.ts
+declare const authProvider: AuthProvider;
+//#endregion
+//#region src/providers/notificationProvider.d.ts
+declare const notificationProvider: () => NotificationProvider;
+//#endregion
+export { AutoSaveIndicator, AutoSaveIndicatorProps, Breadcrumb, BreadcrumbProps, ColorSchemeToggle, ColumnFilter, ColumnSorter, Create, CreateButton, CreateButtonProps, CreateProps, DeleteButton, DeleteButtonProps, Edit, EditButton, EditButtonProps, EditProps, Layout, LayoutLocale, List, ListButton, ListButtonProps, ListProps, LoginArgs, LoginPage, LoginPageProps, Message, MessageProps, OAuthProviderMantine, OtpHandler, RefreshButton, RefreshButtonProps, RegisterForm, RegisterPage, RegisterPageProps, SaveButton, SaveButtonProps, Show, ShowButton, ShowButtonProps, ShowProps, Table, TranslateFn, UseFormProps, UseFormReturnType, authProvider, notificationProvider, useForm, useOtp };