@rbxts/uiblox 0.1.13 → 0.1.15

package/out/ui/enums/Icons.d.ts

@@ -0,0 +1,40 @@
+export declare enum Icons {
+    Delete = "rbxassetid://8583122940",
+    Move = "rbxassetid://8583137072",
+    OpenBox = "rbxassetid://8583122847",
+    Rotate2D = "rbxassetid://8583123169",
+    Rotate3D = "rbxassetid://8583123075",
+    Swipe = "rbxassetid://8583122640",
+    House = "rbxassetid://8771814151",
+    Furniture = "rbxassetid://8771814395",
+    Room = "rbxassetid://8771813821",
+    Arcade = "rbxassetid://8771986472",
+    Controller = "rbxassetid://8771986353",
+    Joystick = "rbxassetid://8771986232",
+    Save = "rbxassetid://8772040340",
+    EditEnabled = "rbxassetid://8772040549",
+    EditDisabled = "rbxassetid://8772040755",
+    Settings = "rbxassetid://8793943638",
+    VerticalDots = "rbxassetid://8793943269",
+    HorizontalDots = "rbxassetid://8793943828",
+    Store = "rbxassetid://8794697193",
+    Dresser = "rbxassetid://8794697532",
+    Hangar = "rbxassetid://8794697340",
+    Friends = "rbxassetid://8794697424",
+    Charity = "rbxassetid://8794697659",
+    Backpack = "rbxassetid://8794716095",
+    HelpBubble = "rbxassetid://8794738823",
+    HelpDesk = "rbxassetid://8835822182",
+    NewspaperVariant1 = "rbxassetid://9056545367",
+    NewspaperVariant2 = "rbxassetid://9056545251",
+    NewspaperVariant3 = "rbxassetid://9056545032",
+    Close = "rbxassetid://9070598165",
+    CloseCircle = "rbxassetid://9070597768",
+    Collapsed = "rbxassetid://9306279342",
+    Expanded = "rbxassetid://9306279848",
+    Book = "rbxassetid://9311703342",
+    BookStack = "rbxassetid://9311703545",
+    ListPrimary = "rbxassetid://9306610505",
+    LightTheme = "rbxassetid://9377269022",
+    DarkTheme = "rbxassetid://9377269322"
+}

package/out/ui/enums/Orientations.d.ts

@@ -0,0 +1,4 @@
+export declare enum Orientations {
+    Vertical = "Vertical",
+    Horizontal = "Horizontal"
+}

package/out/ui/enums/index.d.ts

@@ -0,0 +1,3 @@
+export { Directions } from "./Directions";
+export { Icons } from "./Icons";
+export { Orientations } from "./Orientations";

package/out/ui/index.d.ts

@@ -0,0 +1,34 @@
+export * from "./constants/index";
+export * from "./enums/index";
+export { Divider } from "./packages/index";
+export { DividerProps } from "./packages/index";
+export { Icon } from "./packages/index";
+export { IconProps } from "./packages/index";
+export { IconButton } from "./packages/index";
+export { IconButtonProps } from "./packages/index";
+export { Input } from "./packages/index";
+export { InputProps } from "./packages/index";
+export { InputColor } from "./packages/index";
+export { InputMargin } from "./packages/index";
+export { InputVariant } from "./packages/index";
+export { ProgressBar } from "./packages/index";
+export { ProgressBarProps } from "./packages/index";
+export { Shadow } from "./packages/index";
+export { Sidebar } from "./packages/index";
+export { SidebarProps } from "./packages/index";
+export { SidebarType } from "./packages/index";
+export { Toast } from "./packages/index";
+export { ToastProps } from "./packages/index";
+export { TreeView } from "./packages/index";
+export { TreeViewProps } from "./packages/index";
+export { Branch } from "./packages/index";
+export { Leaf } from "./packages/index";
+export { Tree } from "./packages/index";
+export { Typography } from "./packages/index";
+export { TypographyProps } from "./packages/index";
+export { TypographyAlignment } from "./packages/index";
+export { TypographyColor } from "./packages/index";
+export { TypographyDisplay } from "./packages/index";
+export { Button } from "./packages/index";
+export { ButtonProps } from "./packages/index";
+export * from "./packages/index";

package/out/ui/packages/button/components/Button.d.ts

@@ -0,0 +1,24 @@
+import { CustomizedProps } from "../../../../theme/index";
+import { ButtonSize, ButtonColor, ButtonVariant } from "../types/index";
+export type DefaultButtonComponent = TextButton;
+export interface ButtonProps {
+    text?: string;
+    size?: ButtonSize;
+    color?: ButtonColor;
+    fullWidth?: boolean;
+    variant?: ButtonVariant;
+    disabled?: boolean;
+    loading?: boolean;
+    rounded?: boolean;
+    hoveringDisabled?: boolean;
+    onLeftClick?: () => void;
+    onLeftDown?: () => void;
+    onLeftUp?: () => void;
+    onRightClick?: () => void;
+    onRightDown?: () => void;
+    onRightUp?: () => void;
+    mouseEnter?: () => void;
+    mouseLeave?: () => void;
+}
+declare function Button(props: CustomizedProps<DefaultButtonComponent, ButtonProps>): JSX.Element;
+export default Button;

package/out/ui/packages/button/components/Button.styles.d.ts

@@ -0,0 +1,3 @@
+import { ButtonProps } from "./Button";
+declare const useButtonStyles: (props: ButtonProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useButtonStyles;

package/out/ui/packages/button/index.d.ts

@@ -0,0 +1,6 @@
+export { default as Button } from "./components/Button";
+export { ButtonProps } from "./components/Button";
+export * from "./components/Button";
+export { ButtonColor } from "./types/index";
+export { ButtonSize } from "./types/index";
+export { ButtonVariant } from "./types/index";

package/out/ui/packages/button/types/ButtonColor.d.ts

@@ -0,0 +1 @@
+export type ButtonColor = "primary" | "secondary";

package/out/ui/packages/button/types/ButtonSize.d.ts

@@ -0,0 +1 @@
+export type ButtonSize = "small" | "medium" | "large";

package/out/ui/packages/button/types/ButtonVariant.d.ts

@@ -0,0 +1 @@
+export type ButtonVariant = "contained" | "outlined" | "text";

package/out/ui/packages/button/types/index.d.ts

@@ -0,0 +1,3 @@
+export { ButtonColor } from "./ButtonColor";
+export { ButtonSize } from "./ButtonSize";
+export { ButtonVariant } from "./ButtonVariant";

package/out/ui/packages/divider/components/Divider.d.ts

@@ -0,0 +1,13 @@
+import { CustomizedProps } from "../../../../theme/index";
+import { Orientations } from "../../../enums/index";
+type DefaultDividerComponent = Frame;
+export interface DividerProps {
+    position?: UDim2;
+    orientation?: Orientations;
+    padding?: number;
+    color?: Color3;
+    transparency?: number;
+    weight?: number;
+}
+declare function Divider<T extends DefaultDividerComponent>(props: CustomizedProps<T, DividerProps>): JSX.Element;
+export default Divider;

package/out/ui/packages/divider/components/Divider.styles.d.ts

@@ -0,0 +1,3 @@
+import { DividerProps } from "./Divider";
+declare const useDividerStyles: (props: DividerProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useDividerStyles;

package/out/ui/packages/divider/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Divider } from "./components/Divider";
+export { DividerProps } from "./components/Divider";
+export * from "./components/Divider";

package/out/ui/packages/icon/components/Icon.d.ts

@@ -0,0 +1,10 @@
+import { Icons } from "../../../enums/index";
+import { CustomizedProps } from "../../../../theme/index";
+export interface IconProps {
+    icon: Icons;
+    size?: "xxs" | "xs" | "sm" | "md" | "lg" | "xl";
+    tint?: Color3;
+}
+type DefaultIconComponent = ImageLabel;
+declare function Icon(props: CustomizedProps<DefaultIconComponent, IconProps>): JSX.Element;
+export default Icon;

package/out/ui/packages/icon/components/Icon.styles.d.ts

@@ -0,0 +1,3 @@
+import { IconProps } from "./Icon";
+declare const useIconStyles: (props: IconProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useIconStyles;

package/out/ui/packages/icon/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Icon } from "./components/Icon";
+export { IconProps } from "./components/Icon";
+export * from "./components/Icon";

package/out/ui/packages/iconButton/components/IconButton.d.ts

@@ -0,0 +1,12 @@
+import { Icons } from "../../../enums/index";
+import { CustomizedProps } from "../../../../theme/index";
+export interface IconButtonProps {
+    icon: Icons;
+    size?: "xxs" | "xs" | "sm" | "md" | "lg" | "xl";
+    tint: Color3;
+    selected?: boolean;
+    onClick?: () => void;
+}
+type DefaultIconButtonComponent = ImageButton;
+declare function IconButton(props: CustomizedProps<DefaultIconButtonComponent, IconButtonProps>): JSX.Element;
+export default IconButton;

package/out/ui/packages/iconButton/components/IconButton.styles.d.ts

@@ -0,0 +1,3 @@
+import { IconButtonProps } from "./IconButton";
+declare const useIconButtonStyles: (props: IconButtonProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useIconButtonStyles;

package/out/ui/packages/iconButton/index.d.ts

@@ -0,0 +1,3 @@
+export { default as IconButton } from "./components/IconButton";
+export { IconButtonProps } from "./components/IconButton";
+export * from "./components/IconButton";

package/out/ui/packages/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./divider/index";
+export * from "./icon/index";
+export * from "./iconButton/index";
+export * from "./input/index";
+export * from "./progressBar/index";
+export * from "./shadow/index";
+export * from "./sidebar/index";
+export * from "./toast/index";
+export * from "./treeView/index";
+export * from "./typography/index";
+export * from "./button/index";

package/out/ui/packages/input/components/Input.d.ts

@@ -0,0 +1,22 @@
+import { CustomizedProps } from "../../../../theme/index";
+import { InputColor, InputMargin, InputVariant } from "../types/index";
+export type DefaultInputComponent = Frame;
+export interface InputProps {
+    color?: InputColor;
+    disabled?: boolean;
+    hasError?: boolean;
+    helperText?: string;
+    margin?: InputMargin;
+    variant?: InputVariant;
+    width?: UDim;
+    text?: string;
+    placeholder?: string;
+    rounded?: boolean;
+    clearsTextOnFocus?: boolean;
+    onTextChanged?: (text: string) => void;
+    onFocus?: () => void;
+    onBlur?: () => void;
+    onEnterPressed?: (text: string) => void;
+}
+declare function Input(props: CustomizedProps<DefaultInputComponent, InputProps>): JSX.Element;
+export default Input;

package/out/ui/packages/input/components/Input.styles.d.ts

@@ -0,0 +1,3 @@
+import { InputProps } from "./Input";
+declare const useInputStyles: (props: InputProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useInputStyles;

package/out/ui/packages/input/index.d.ts

@@ -0,0 +1,6 @@
+export { default as Input } from "./components/Input";
+export { InputProps } from "./components/Input";
+export * from "./components/Input";
+export { InputColor } from "./types/index";
+export { InputMargin } from "./types/index";
+export { InputVariant } from "./types/index";

package/out/ui/packages/input/types/InputColor.d.ts

@@ -0,0 +1 @@
+export type InputColor = "primary" | "secondary";

package/out/ui/packages/input/types/InputMargin.d.ts

@@ -0,0 +1 @@
+export type InputMargin = "none" | "dense" | "normal";

package/out/ui/packages/input/types/InputVariant.d.ts

@@ -0,0 +1 @@
+export type InputVariant = "filled" | "outlined" | "standard";

package/out/ui/packages/input/types/index.d.ts

@@ -0,0 +1,3 @@
+export { InputColor } from "./InputColor";
+export { InputMargin } from "./InputMargin";
+export { InputVariant } from "./InputVariant";

package/out/ui/packages/progressBar/components/ProgressBar.d.ts

@@ -0,0 +1,7 @@
+import { WriteableStyle } from "../../../../theme/index";
+export interface ProgressBarProps {
+    progress: number;
+    className?: WriteableStyle<Frame>;
+}
+declare function ProgressBar({ progress, className }: ProgressBarProps): JSX.Element;
+export default ProgressBar;

package/out/ui/packages/progressBar/components/ProgressBar.styles.d.ts

@@ -0,0 +1,2 @@
+declare const useProgressBarStyles: () => import("../../../../theme/index").ClassNameMap<string>;
+export default useProgressBarStyles;

package/out/ui/packages/progressBar/index.d.ts

@@ -0,0 +1,3 @@
+export { default as ProgressBar } from "./components/ProgressBar";
+export { ProgressBarProps } from "./components/ProgressBar";
+export * from "./components/ProgressBar";

package/out/ui/packages/shadow/components/Shadow.d.ts

@@ -0,0 +1,2 @@
+declare function Shadow(): JSX.Element;
+export default Shadow;

package/out/ui/packages/shadow/components/Shadow.styles.d.ts

@@ -0,0 +1,2 @@
+declare const useShadowStyles: () => import("../../../../theme/index").ClassNameMap<string>;
+export default useShadowStyles;

package/out/ui/packages/shadow/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Shadow } from "./components/Shadow";
+export * from "./components/Shadow";

package/out/ui/packages/sidebar/components/Sidebar.d.ts

@@ -0,0 +1,8 @@
+import { CustomizedProps } from "../../../../theme/index";
+export type DefaultSidebarComponent = Frame;
+export interface SidebarProps {
+    size: "compact" | "large";
+    ignoreInset?: boolean;
+}
+declare function Sidebar<T extends DefaultSidebarComponent>(props: CustomizedProps<T, SidebarProps>): JSX.Element;
+export default Sidebar;

package/out/ui/packages/sidebar/components/Sidebar.styles.d.ts

@@ -0,0 +1,3 @@
+import { SidebarProps } from "./Sidebar";
+declare const useSidebarStyles: (props: SidebarProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useSidebarStyles;

package/out/ui/packages/sidebar/index.d.ts

@@ -0,0 +1,4 @@
+export { default as Sidebar } from "./components/Sidebar";
+export { SidebarProps } from "./components/Sidebar";
+export * from "./components/Sidebar";
+export { SidebarType } from "./types/index";

package/out/ui/packages/sidebar/types/SidebarType.d.ts

@@ -0,0 +1 @@
+export type SidebarType = "compact" | "large";

package/out/ui/packages/sidebar/types/index.d.ts

@@ -0,0 +1 @@
+export { SidebarType } from "./SidebarType";

package/out/ui/packages/toast/components/Toast.d.ts

@@ -0,0 +1,10 @@
+import ToastVariants from "../enums/ToastVariants";
+export interface ToastProps {
+    text: string;
+    onDismiss: () => void;
+    duration?: number;
+    variant?: ToastVariants;
+    toggledAt?: number;
+}
+declare function Toast(props: ToastProps): JSX.Element;
+export default Toast;

package/out/ui/packages/toast/components/Toast.styles.d.ts

@@ -0,0 +1,3 @@
+import { ToastProps } from "./Toast";
+declare const useToastStyles: (props: ToastProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useToastStyles;

package/out/ui/packages/toast/enums/ToastVariants.d.ts

@@ -0,0 +1,7 @@
+declare enum ToastVariants {
+    default = "default",
+    success = "success",
+    error = "error",
+    warning = "warning"
+}
+export default ToastVariants;

package/out/ui/packages/toast/index.d.ts

@@ -0,0 +1,5 @@
+export { default as Toast } from "./components/Toast";
+export { ToastProps } from "./components/Toast";
+export * from "./components/Toast";
+export { default as ToastVariants } from "./enums/ToastVariants";
+export { default as ToastEvent } from "./interfaces/ToastEvent";

package/out/ui/packages/toast/interfaces/ToastEvent.d.ts

@@ -0,0 +1,5 @@
+interface ToastEvent {
+    success: boolean;
+    timestamp: number;
+}
+export default ToastEvent;

package/out/ui/packages/treeView/components/TreeView.d.ts

@@ -0,0 +1,11 @@
+import { CustomizedProps } from "../../../../theme/index";
+import { Icons } from "../../../enums/index";
+import Tree from "../interfaces/Tree";
+type DefaultTreeViewComponent = Frame;
+export interface TreeViewProps {
+    tree: Tree;
+    icon?: Icons;
+    filter?: string;
+}
+declare function TreeView(props: CustomizedProps<DefaultTreeViewComponent, TreeViewProps>): JSX.Element;
+export default TreeView;

package/out/ui/packages/treeView/components/TreeView.styles.d.ts

@@ -0,0 +1,2 @@
+declare const useTreeViewStyles: () => import("../../../../theme/index").ClassNameMap<string>;
+export default useTreeViewStyles;

package/out/ui/packages/treeView/index.d.ts

@@ -0,0 +1,6 @@
+export { default as TreeView } from "./components/TreeView";
+export { TreeViewProps } from "./components/TreeView";
+export * from "./components/TreeView";
+export { default as Branch } from "./interfaces/Branch";
+export { default as Leaf } from "./interfaces/Leaf";
+export { default as Tree } from "./interfaces/Tree";

package/out/ui/packages/treeView/interfaces/Branch.d.ts

@@ -0,0 +1,6 @@
+import Leaf from "./Leaf";
+export default interface Branch {
+    title: string;
+    leaves: Leaf[];
+    onClick?: () => void;
+}

package/out/ui/packages/treeView/interfaces/Leaf.d.ts

@@ -0,0 +1,4 @@
+export default interface Leaf {
+    title: string;
+    onClick?: () => void;
+}

package/out/ui/packages/treeView/interfaces/Tree.d.ts

@@ -0,0 +1,5 @@
+import Branch from "./Branch";
+export default interface Tree {
+    title: string;
+    branches: Branch[];
+}

package/out/ui/packages/typography/components/Typography.d.ts

@@ -0,0 +1,18 @@
+import { CustomizedProps } from "../../../../theme/index";
+import { FontFamilyVariant, FontSizeVariant } from "../../../../theme/interfaces/typography/index";
+import { TypographyAlignment } from "../types/TypographyAlignment";
+import { TypographyColor } from "../types/TypographyColor";
+import { TypographyDisplay } from "../types/TypographyDisplay";
+type DefaultTypographyComponent = TextLabel;
+export interface TypographyProps {
+    text?: string;
+    variant?: FontSizeVariant;
+    family?: FontFamilyVariant;
+    color?: TypographyColor;
+    display?: TypographyDisplay;
+    align?: TypographyAlignment;
+    noWrap?: boolean;
+    lineClamp?: boolean;
+}
+declare function Typography<T extends DefaultTypographyComponent>(props: CustomizedProps<T, TypographyProps>): JSX.Element;
+export default Typography;

package/out/ui/packages/typography/components/Typography.styles.d.ts

@@ -0,0 +1,3 @@
+import { TypographyProps } from "./Typography";
+declare const useTypographyStyles: (props: TypographyProps) => import("../../../../theme/index").ClassNameMap<string>;
+export default useTypographyStyles;

package/out/ui/packages/typography/index.d.ts

@@ -0,0 +1,6 @@
+export { default as Typography } from "./components/Typography";
+export { TypographyProps } from "./components/Typography";
+export * from "./components/Typography";
+export { TypographyAlignment } from "./types/index";
+export { TypographyColor } from "./types/index";
+export { TypographyDisplay } from "./types/index";

package/out/ui/packages/typography/types/TypographyAlignment.d.ts

@@ -0,0 +1 @@
+export type TypographyAlignment = "left" | "center" | "right";

package/out/ui/packages/typography/types/TypographyColor.d.ts

@@ -0,0 +1 @@
+export type TypographyColor = "initial" | "inherit" | "primary" | "secondary" | "textPrimary" | "textSecondary" | "error" | "warning";

package/out/ui/packages/typography/types/TypographyDisplay.d.ts

@@ -0,0 +1 @@
+export type TypographyDisplay = "initial" | "block" | "inline";

package/out/ui/packages/typography/types/index.d.ts

@@ -0,0 +1,3 @@
+export { TypographyAlignment } from "./TypographyAlignment";
+export { TypographyColor } from "./TypographyColor";
+export { TypographyDisplay } from "./TypographyDisplay";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rbxts/uiblox",
-	"version": "0.1.13",
+	"version": "0.1.15",
 	"description": "UI Library and theming for roblox-ts projects",
 	"main": "out/init.lua",
 	"scripts": {