@sikka/hawa 0.2.0 → 0.2.2-beta

package/.github/workflows/hawa-beta.yml

@@ -18,7 +18,11 @@ jobs:
         node-version: [16.x]
     steps:
       - uses: actions/checkout@v2
-
+      - name: Append -beta to package.json version
+        run: |
+          apt-get update && apt-get install -y jq
+          jq '.version = .version + "-beta"' package.json > package.json.tmp
+          mv package.json.tmp package.json
       - name: Use Node.js v16
         uses: actions/setup-node@v2
         with:

package/README.md

@@ -4,15 +4,21 @@
 
 # Hawa | هواء
 
-[![NPM](https://img.shields.io/npm/v/@sikka/hawa.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@sikka/hawa)
-[![NPM](https://img.shields.io/npm/dt/@sikka/hawa.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@sikka/hawa)
+[![NPM](https://img.shields.io/npm/v/@sikka/hawa.svg?style=flat&colorA=000000&colorB=1082c3)](https://www.npmjs.com/package/@sikka/hawa)
+[![NPM@beta](https://img.shields.io/npm/v/@sikka/hawa/beta.svg?style=flat&colorA=000000&colorB=ea7637)](https://www.npmjs.com/package/@sikka/hawa)
+[![Hawa CI - @latest](https://github.com/sikka-software/Hawa/actions/workflows/hawa-main.yml/badge.svg)](https://github.com/sikka-software/Hawa/actions/workflows/hawa-main.yml)
+[![Hawa CI - @beta](https://github.com/sikka-software/Hawa/actions/workflows/hawa-beta.yml/badge.svg)](https://github.com/sikka-software/Hawa/actions/workflows/hawa-beta.yml)
+<!-- [![NPM](https://img.shields.io/npm/dt/@sikka/hawa.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@sikka/hawa) -->
+
+
 
 > Opinionated UI Kit for web apps and websites built with TailwindCSS
 
 [Docs](https://hawa.style/docs)
 
 ## Install
-
+**Note:** `@beta` only points to pre-releases.
+Use `@latest` for the latest stable release.
 ```bash
 npm install @sikka/hawa
 ```

package/dist/index.d.mts

@@ -778,25 +778,25 @@ type ComponentTypes = {
 };
 declare const UserReferralSource: FC<ComponentTypes>;
 
-type IconProps = React.HTMLAttributes<SVGElement>;
+type IconProps = React__default.HTMLAttributes<SVGElement>;
 declare const Icons: {
-    logo: (props: IconProps) => React$1.JSX.Element;
-    mail: (props: IconProps) => React$1.JSX.Element;
-    phone: (props: IconProps) => React$1.JSX.Element;
-    twitter: (props: IconProps) => React$1.JSX.Element;
-    microsoft: (props: IconProps) => React$1.JSX.Element;
-    gitHub: (props: IconProps) => React$1.JSX.Element;
-    radix: (props: IconProps) => React$1.JSX.Element;
-    aria: (props: IconProps) => React$1.JSX.Element;
-    npm: (props: IconProps) => React$1.JSX.Element;
-    yarn: (props: IconProps) => React$1.JSX.Element;
-    pnpm: (props: IconProps) => React$1.JSX.Element;
-    react: (props: IconProps) => React$1.JSX.Element;
-    tailwind: (props: IconProps) => React$1.JSX.Element;
-    google: (props: IconProps) => React$1.JSX.Element;
-    apple: (props: IconProps) => React$1.JSX.Element;
-    paypal: (props: IconProps) => React$1.JSX.Element;
-    spinner: (props: IconProps) => React$1.JSX.Element;
+    logo: (props: IconProps) => React__default.JSX.Element;
+    mail: (props: IconProps) => React__default.JSX.Element;
+    phone: (props: IconProps) => React__default.JSX.Element;
+    twitter: (props: IconProps) => React__default.JSX.Element;
+    microsoft: (props: IconProps) => React__default.JSX.Element;
+    gitHub: (props: IconProps) => React__default.JSX.Element;
+    radix: (props: IconProps) => React__default.JSX.Element;
+    aria: (props: IconProps) => React__default.JSX.Element;
+    npm: (props: IconProps) => React__default.JSX.Element;
+    yarn: (props: IconProps) => React__default.JSX.Element;
+    pnpm: (props: IconProps) => React__default.JSX.Element;
+    react: (props: IconProps) => React__default.JSX.Element;
+    tailwind: (props: IconProps) => React__default.JSX.Element;
+    google: (props: IconProps) => React__default.JSX.Element;
+    apple: (props: IconProps) => React__default.JSX.Element;
+    paypal: (props: IconProps) => React__default.JSX.Element;
+    spinner: (props: IconProps) => React__default.JSX.Element;
 };
 
 declare const buttonVariants: (props?: {
@@ -969,6 +969,7 @@ type AppLayoutTypes = {
     profileMenuWidth: "default" | "sm" | "lg" | "parent";
     onSettingsClick?: () => void;
     onDrawerExpand?: (e: any) => void;
+    keepDrawerOpen?: boolean;
     DrawerFooterActions?: any;
     clickedItem?: any;
     texts?: {
@@ -1744,4 +1745,41 @@ declare function useToast(): {
     toasts: ToasterToast[];
 };
 
-export { ActionCard, Announcement, AppLanding, AppLayout, AppSidebar, ArrowCarousel, BackToTop, Box, Button, ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, ChargeWalletForm, CheckEmail, CheckoutForm, CodeConfirmation, ComparingPlans, ConfirmationPage, CreditCardForm, Dialog, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogTitle, DialogTrigger, DragDropImages, DraggableCard, DropdownMenu, EmptyState, FloatingComment, FloatingCommentExec, FloatingCommentSlate, Footer, HawaAccordion, HawaAdCard, HawaAlert, HawaAppLayout, HawaAppLayoutSimplified, HawaBanner, HawaBottomAppBar, HawaButton, HawaCheckbox, HawaChip, HawaCodeBlock, HawaColorPicker, HawaContainer, HawaCopyrights, HawaDatepicker, HawaGrid, HawaIconCount, HawaInlineCode, HawaItemCard, HawaLandingCard, HawaLoading, HawaMenu, HawaModal, HawaPanelTabs, HawaPhoneInput, HawaPinInput, HawaPricingCard, HawaRadio, HawaRange, HawaSearchBar, HawaSelect, HawaSettingsRow, HawaSiteLayout, HawaStats, HawaStepper, HawaStoreButtons, HawaTable, HawaTabs, HawaTextField, HawaTypography, HorizontalPricing, Icons, Input, InputProps, InterfaceSettings, InvoiceAccordion, Label, LeadGenerator, MenuItemType, NewPasswordForm, NoPermission, NotFound, PayWithWallet, Popover, PricingPlans, ReferralAccount, ReferralSettlement, ReferralStats, ResetPasswordForm, SelectPayment, Separator, SidebarGroup, SidebarItem, SignInBlock, SignInForm, SignInPhone, SignUpForm, Skeleton, StickyFeatures, SubItem$2 as SubItem, SubsectionList, Switch, Tabs, TabsContent, TabsList, TabsTrigger, Testimonial, Textarea, TextareaProps, Timeline, Toast$1 as Toast, ToastAction, ToastActionElement, ToastClose, ToastDescription, ToastProps, ToastProvider, ToastTitle, ToastViewport, Toaster, Tooltip, UsageCard, UserFeedback, UserProfileForm, UserReferralSource, UserSettingsForm, buttonVariants, reducer, toast, useToast };
+declare function useClipboard({ timeout }?: {
+    timeout?: number;
+}): {
+    copy: (valueToCopy: any) => void;
+    reset: () => void;
+    error: Error;
+    copied: boolean;
+};
+
+interface UseFocusWithinOptions {
+    onFocus?(event: FocusEvent): void;
+    onBlur?(event: FocusEvent): void;
+}
+declare function useFocusWithin<T extends HTMLElement = any>({ onBlur, onFocus, }?: UseFocusWithinOptions): {
+    ref: React.MutableRefObject<T>;
+    focused: boolean;
+};
+
+interface UseMediaQueryOptions {
+    getInitialValueInEffect: boolean;
+}
+declare function useMediaQuery(query: string, initialValue?: boolean, { getInitialValueInEffect }?: UseMediaQueryOptions): boolean;
+
+declare function useTabs(initialTab?: string): {
+    activeTab: string;
+    handleTabChange: (index: any) => void;
+};
+
+declare function useWindowEvent<K extends string = keyof WindowEventMap>(type: K, listener: K extends keyof WindowEventMap ? (this: Window, ev: WindowEventMap[K]) => void : (this: Window, ev: CustomEvent) => void, options?: boolean | AddEventListenerOptions): void;
+
+interface ScrollPosition {
+    x: number;
+    y: number;
+}
+declare function scrollTo({ x, y }: Partial<ScrollPosition>): void;
+declare function useWindowScroll(): readonly [ScrollPosition, typeof scrollTo];
+
+export { ActionCard, Announcement, AppLanding, AppLayout, AppSidebar, ArrowCarousel, BackToTop, Box, Button, ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, ChargeWalletForm, CheckEmail, CheckoutForm, CodeConfirmation, ComparingPlans, ConfirmationPage, CreditCardForm, Dialog, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogTitle, DialogTrigger, DragDropImages, DraggableCard, DropdownMenu, EmptyState, FloatingComment, FloatingCommentExec, FloatingCommentSlate, Footer, HawaAccordion, HawaAdCard, HawaAlert, HawaAppLayout, HawaAppLayoutSimplified, HawaBanner, HawaBottomAppBar, HawaButton, HawaCheckbox, HawaChip, HawaCodeBlock, HawaColorPicker, HawaContainer, HawaCopyrights, HawaDatepicker, HawaGrid, HawaIconCount, HawaInlineCode, HawaItemCard, HawaLandingCard, HawaLoading, HawaMenu, HawaModal, HawaPanelTabs, HawaPhoneInput, HawaPinInput, HawaPricingCard, HawaRadio, HawaRange, HawaSearchBar, HawaSelect, HawaSettingsRow, HawaSiteLayout, HawaStats, HawaStepper, HawaStoreButtons, HawaTable, HawaTabs, HawaTextField, HawaTypography, HorizontalPricing, Icons, Input, InputProps, InterfaceSettings, InvoiceAccordion, Label, LeadGenerator, MenuItemType, NewPasswordForm, NoPermission, NotFound, PayWithWallet, Popover, PricingPlans, ReferralAccount, ReferralSettlement, ReferralStats, ResetPasswordForm, SelectPayment, Separator, SidebarGroup, SidebarItem, SignInBlock, SignInForm, SignInPhone, SignUpForm, Skeleton, StickyFeatures, SubItem$2 as SubItem, SubsectionList, Switch, Tabs, TabsContent, TabsList, TabsTrigger, Testimonial, Textarea, TextareaProps, Timeline, Toast$1 as Toast, ToastAction, ToastActionElement, ToastClose, ToastDescription, ToastProps, ToastProvider, ToastTitle, ToastViewport, Toaster, Tooltip, UsageCard, UseFocusWithinOptions, UseMediaQueryOptions, UserFeedback, UserProfileForm, UserReferralSource, UserSettingsForm, buttonVariants, reducer, toast, useClipboard, useFocusWithin, useMediaQuery, useTabs, useToast, useWindowEvent, useWindowScroll };

package/dist/index.d.ts

@@ -778,25 +778,25 @@ type ComponentTypes = {
 };
 declare const UserReferralSource: FC<ComponentTypes>;
 
-type IconProps = React.HTMLAttributes<SVGElement>;
+type IconProps = React__default.HTMLAttributes<SVGElement>;
 declare const Icons: {
-    logo: (props: IconProps) => React$1.JSX.Element;
-    mail: (props: IconProps) => React$1.JSX.Element;
-    phone: (props: IconProps) => React$1.JSX.Element;
-    twitter: (props: IconProps) => React$1.JSX.Element;
-    microsoft: (props: IconProps) => React$1.JSX.Element;
-    gitHub: (props: IconProps) => React$1.JSX.Element;
-    radix: (props: IconProps) => React$1.JSX.Element;
-    aria: (props: IconProps) => React$1.JSX.Element;
-    npm: (props: IconProps) => React$1.JSX.Element;
-    yarn: (props: IconProps) => React$1.JSX.Element;
-    pnpm: (props: IconProps) => React$1.JSX.Element;
-    react: (props: IconProps) => React$1.JSX.Element;
-    tailwind: (props: IconProps) => React$1.JSX.Element;
-    google: (props: IconProps) => React$1.JSX.Element;
-    apple: (props: IconProps) => React$1.JSX.Element;
-    paypal: (props: IconProps) => React$1.JSX.Element;
-    spinner: (props: IconProps) => React$1.JSX.Element;
+    logo: (props: IconProps) => React__default.JSX.Element;
+    mail: (props: IconProps) => React__default.JSX.Element;
+    phone: (props: IconProps) => React__default.JSX.Element;
+    twitter: (props: IconProps) => React__default.JSX.Element;
+    microsoft: (props: IconProps) => React__default.JSX.Element;
+    gitHub: (props: IconProps) => React__default.JSX.Element;
+    radix: (props: IconProps) => React__default.JSX.Element;
+    aria: (props: IconProps) => React__default.JSX.Element;
+    npm: (props: IconProps) => React__default.JSX.Element;
+    yarn: (props: IconProps) => React__default.JSX.Element;
+    pnpm: (props: IconProps) => React__default.JSX.Element;
+    react: (props: IconProps) => React__default.JSX.Element;
+    tailwind: (props: IconProps) => React__default.JSX.Element;
+    google: (props: IconProps) => React__default.JSX.Element;
+    apple: (props: IconProps) => React__default.JSX.Element;
+    paypal: (props: IconProps) => React__default.JSX.Element;
+    spinner: (props: IconProps) => React__default.JSX.Element;
 };
 
 declare const buttonVariants: (props?: {
@@ -969,6 +969,7 @@ type AppLayoutTypes = {
     profileMenuWidth: "default" | "sm" | "lg" | "parent";
     onSettingsClick?: () => void;
     onDrawerExpand?: (e: any) => void;
+    keepDrawerOpen?: boolean;
     DrawerFooterActions?: any;
     clickedItem?: any;
     texts?: {
@@ -1744,4 +1745,41 @@ declare function useToast(): {
     toasts: ToasterToast[];
 };
 
-export { ActionCard, Announcement, AppLanding, AppLayout, AppSidebar, ArrowCarousel, BackToTop, Box, Button, ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, ChargeWalletForm, CheckEmail, CheckoutForm, CodeConfirmation, ComparingPlans, ConfirmationPage, CreditCardForm, Dialog, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogTitle, DialogTrigger, DragDropImages, DraggableCard, DropdownMenu, EmptyState, FloatingComment, FloatingCommentExec, FloatingCommentSlate, Footer, HawaAccordion, HawaAdCard, HawaAlert, HawaAppLayout, HawaAppLayoutSimplified, HawaBanner, HawaBottomAppBar, HawaButton, HawaCheckbox, HawaChip, HawaCodeBlock, HawaColorPicker, HawaContainer, HawaCopyrights, HawaDatepicker, HawaGrid, HawaIconCount, HawaInlineCode, HawaItemCard, HawaLandingCard, HawaLoading, HawaMenu, HawaModal, HawaPanelTabs, HawaPhoneInput, HawaPinInput, HawaPricingCard, HawaRadio, HawaRange, HawaSearchBar, HawaSelect, HawaSettingsRow, HawaSiteLayout, HawaStats, HawaStepper, HawaStoreButtons, HawaTable, HawaTabs, HawaTextField, HawaTypography, HorizontalPricing, Icons, Input, InputProps, InterfaceSettings, InvoiceAccordion, Label, LeadGenerator, MenuItemType, NewPasswordForm, NoPermission, NotFound, PayWithWallet, Popover, PricingPlans, ReferralAccount, ReferralSettlement, ReferralStats, ResetPasswordForm, SelectPayment, Separator, SidebarGroup, SidebarItem, SignInBlock, SignInForm, SignInPhone, SignUpForm, Skeleton, StickyFeatures, SubItem$2 as SubItem, SubsectionList, Switch, Tabs, TabsContent, TabsList, TabsTrigger, Testimonial, Textarea, TextareaProps, Timeline, Toast$1 as Toast, ToastAction, ToastActionElement, ToastClose, ToastDescription, ToastProps, ToastProvider, ToastTitle, ToastViewport, Toaster, Tooltip, UsageCard, UserFeedback, UserProfileForm, UserReferralSource, UserSettingsForm, buttonVariants, reducer, toast, useToast };
+declare function useClipboard({ timeout }?: {
+    timeout?: number;
+}): {
+    copy: (valueToCopy: any) => void;
+    reset: () => void;
+    error: Error;
+    copied: boolean;
+};
+
+interface UseFocusWithinOptions {
+    onFocus?(event: FocusEvent): void;
+    onBlur?(event: FocusEvent): void;
+}
+declare function useFocusWithin<T extends HTMLElement = any>({ onBlur, onFocus, }?: UseFocusWithinOptions): {
+    ref: React.MutableRefObject<T>;
+    focused: boolean;
+};
+
+interface UseMediaQueryOptions {
+    getInitialValueInEffect: boolean;
+}
+declare function useMediaQuery(query: string, initialValue?: boolean, { getInitialValueInEffect }?: UseMediaQueryOptions): boolean;
+
+declare function useTabs(initialTab?: string): {
+    activeTab: string;
+    handleTabChange: (index: any) => void;
+};
+
+declare function useWindowEvent<K extends string = keyof WindowEventMap>(type: K, listener: K extends keyof WindowEventMap ? (this: Window, ev: WindowEventMap[K]) => void : (this: Window, ev: CustomEvent) => void, options?: boolean | AddEventListenerOptions): void;
+
+interface ScrollPosition {
+    x: number;
+    y: number;
+}
+declare function scrollTo({ x, y }: Partial<ScrollPosition>): void;
+declare function useWindowScroll(): readonly [ScrollPosition, typeof scrollTo];
+
+export { ActionCard, Announcement, AppLanding, AppLayout, AppSidebar, ArrowCarousel, BackToTop, Box, Button, ButtonProps, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, ChargeWalletForm, CheckEmail, CheckoutForm, CodeConfirmation, ComparingPlans, ConfirmationPage, CreditCardForm, Dialog, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogTitle, DialogTrigger, DragDropImages, DraggableCard, DropdownMenu, EmptyState, FloatingComment, FloatingCommentExec, FloatingCommentSlate, Footer, HawaAccordion, HawaAdCard, HawaAlert, HawaAppLayout, HawaAppLayoutSimplified, HawaBanner, HawaBottomAppBar, HawaButton, HawaCheckbox, HawaChip, HawaCodeBlock, HawaColorPicker, HawaContainer, HawaCopyrights, HawaDatepicker, HawaGrid, HawaIconCount, HawaInlineCode, HawaItemCard, HawaLandingCard, HawaLoading, HawaMenu, HawaModal, HawaPanelTabs, HawaPhoneInput, HawaPinInput, HawaPricingCard, HawaRadio, HawaRange, HawaSearchBar, HawaSelect, HawaSettingsRow, HawaSiteLayout, HawaStats, HawaStepper, HawaStoreButtons, HawaTable, HawaTabs, HawaTextField, HawaTypography, HorizontalPricing, Icons, Input, InputProps, InterfaceSettings, InvoiceAccordion, Label, LeadGenerator, MenuItemType, NewPasswordForm, NoPermission, NotFound, PayWithWallet, Popover, PricingPlans, ReferralAccount, ReferralSettlement, ReferralStats, ResetPasswordForm, SelectPayment, Separator, SidebarGroup, SidebarItem, SignInBlock, SignInForm, SignInPhone, SignUpForm, Skeleton, StickyFeatures, SubItem$2 as SubItem, SubsectionList, Switch, Tabs, TabsContent, TabsList, TabsTrigger, Testimonial, Textarea, TextareaProps, Timeline, Toast$1 as Toast, ToastAction, ToastActionElement, ToastClose, ToastDescription, ToastProps, ToastProvider, ToastTitle, ToastViewport, Toaster, Tooltip, UsageCard, UseFocusWithinOptions, UseMediaQueryOptions, UserFeedback, UserProfileForm, UserReferralSource, UserSettingsForm, buttonVariants, reducer, toast, useClipboard, useFocusWithin, useMediaQuery, useTabs, useToast, useWindowEvent, useWindowScroll };