Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: use type over interface for TS type definitions #47

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion resources/js/components/app-content.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { SidebarInset } from '@/components/ui/sidebar';
import * as React from 'react';

interface AppContentProps extends React.ComponentProps<'div'> {
type AppContentProps = React.ComponentProps<'div'> & {
variant?: 'header' | 'sidebar';
}

Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/app-header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const rightNavItems: NavItem[] = [

const activeItemStyles = 'text-neutral-900 dark:bg-neutral-800 dark:text-neutral-100';

interface AppHeaderProps {
type AppHeaderProps = {
breadcrumbs?: BreadcrumbItem[];
}

Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/app-shell.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { SidebarProvider } from '@/components/ui/sidebar';
import { useState } from 'react';

interface AppShellProps {
type AppShellProps = {
children: React.ReactNode;
variant?: 'header' | 'sidebar';
}
Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/icon.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { cn } from '@/lib/utils';
import { type LucideProps } from 'lucide-react';

interface IconProps extends Omit<LucideProps, 'ref'> {
type IconProps = Omit<LucideProps, 'ref'> & {
iconNode: React.ComponentType<LucideProps>;
}

Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/ui/badge.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ const badgeVariants = cva(
},
);

export interface BadgeProps extends React.HTMLAttributes<HTMLDivElement>, VariantProps<typeof badgeVariants> {}
export type BadgeProps = React.HTMLAttributes<HTMLDivElement> & VariantProps<typeof badgeVariants>;

function Badge({ className, variant, ...props }: BadgeProps) {
return <div className={cn(badgeVariants({ variant }), className)} {...props} />;
Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/ui/button.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const buttonVariants = cva(
},
);

export interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants> {
export type ButtonProps = React.ButtonHTMLAttributes<HTMLButtonElement> & VariantProps<typeof buttonVariants> & {
asChild?: boolean;
}

Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/ui/icon.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { LucideIcon } from 'lucide-react';

interface IconProps {
type IconProps = {
iconNode?: LucideIcon | null;
className?: string;
}
Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/ui/placeholder-pattern.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useId } from 'react';

interface PlaceholderPatternProps {
type PlaceholderPatternProps = {
className?: string;
}

Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/ui/sheet.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ const sheetVariants = cva(
},
);

interface SheetContentProps extends React.ComponentPropsWithoutRef<typeof SheetPrimitive.Content>, VariantProps<typeof sheetVariants> {}
type SheetContentProps = React.ComponentPropsWithoutRef<typeof SheetPrimitive.Content> & VariantProps<typeof sheetVariants>

const SheetContent = React.forwardRef<React.ElementRef<typeof SheetPrimitive.Content>, SheetContentProps>(
({ side = 'right', className, children, ...props }, ref) => (
Expand Down
2 changes: 1 addition & 1 deletion resources/js/components/user-menu-content.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { type User } from '@/types';
import { Link } from '@inertiajs/react';
import { LogOut, Settings } from 'lucide-react';

interface UserMenuContentProps {
type UserMenuContentProps = {
user: User;
}

Expand Down
2 changes: 1 addition & 1 deletion resources/js/layouts/app-layout.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import AppLayoutTemplate from '@/layouts/app/app-sidebar-layout';
import { type BreadcrumbItem } from '@/types';

interface AppLayoutProps {
type AppLayoutProps = {
children: React.ReactNode;
breadcrumbs?: BreadcrumbItem[];
}
Expand Down
2 changes: 1 addition & 1 deletion resources/js/layouts/app/app-header-layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { AppHeader } from '@/components/app-header';
import { AppShell } from '@/components/app-shell';
import { type BreadcrumbItem } from '@/types';

interface AppHeaderLayoutProps {
type AppHeaderLayoutProps = {
children: React.ReactNode;
breadcrumbs?: BreadcrumbItem[];
}
Expand Down
2 changes: 1 addition & 1 deletion resources/js/layouts/auth/auth-simple-layout.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import AppLogoIcon from '@/components/app-logo-icon';
import { Link } from '@inertiajs/react';

interface AuthLayoutProps {
type AuthLayoutProps = {
children: React.ReactNode;
name?: string;
title?: string;
Expand Down
2 changes: 1 addition & 1 deletion resources/js/layouts/auth/auth-split-layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import AppLogoIcon from '@/components/app-logo-icon';
import { type SharedData } from '@/types';
import { Link, usePage } from '@inertiajs/react';

interface AuthLayoutProps {
type AuthLayoutProps = {
children: React.ReactNode;
title?: string;
description?: string;
Expand Down
4 changes: 2 additions & 2 deletions resources/js/pages/auth/login.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ import { Input } from '@/components/ui/input';
import { Label } from '@/components/ui/label';
import AuthLayout from '@/layouts/auth-layout';

interface LoginForm {
type LoginForm = {
email: string;
password: string;
remember: boolean;
}

interface LoginProps {
type LoginProps = {
status?: string;
canResetPassword: boolean;
}
Expand Down
2 changes: 1 addition & 1 deletion resources/js/pages/auth/register.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Input } from '@/components/ui/input';
import { Label } from '@/components/ui/label';
import AuthLayout from '@/layouts/auth-layout';

interface RegisterForm {
type RegisterForm = {
name: string;
email: string;
password: string;
Expand Down
4 changes: 2 additions & 2 deletions resources/js/pages/auth/reset-password.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ import { Input } from '@/components/ui/input';
import { Label } from '@/components/ui/label';
import AuthLayout from '@/layouts/auth-layout';

interface ResetPasswordProps {
type ResetPasswordProps = {
token: string;
email: string;
}

interface ResetPasswordForm {
type ResetPasswordForm = {
token: string;
email: string;
password: string;
Expand Down
12 changes: 6 additions & 6 deletions resources/js/types/index.ts
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
import { LucideIcon } from 'lucide-react';

export interface Auth {
export type Auth = {
user: User;
}

export interface BreadcrumbItem {
export type BreadcrumbItem = {
title: string;
href: string;
}

export interface NavGroup {
export type NavGroup = {
title: string;
items: NavItem[];
}

export interface NavItem {
export type NavItem = {
title: string;
url: string;
icon?: LucideIcon | null;
isActive?: boolean;
}

export interface SharedData {
export type SharedData = {
name: string;
quote: { message: string; author: string };
auth: Auth;
[key: string]: unknown;
}

export interface User {
export type User = {
id: number;
name: string;
email: string;
Expand Down