Skip to content

A collection of utility functions, types and composables. Nothing too fancy, but could be useful

Notifications You must be signed in to change notification settings

zayne-labs/toolkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

9760d51 Β· Feb 20, 2025
Jan 29, 2025
Feb 16, 2025
Sep 3, 2024
Sep 3, 2024
Feb 20, 2025
Feb 20, 2025
Aug 30, 2024
Jan 2, 2025
Aug 30, 2024
Jan 12, 2025
Dec 29, 2024
Jan 2, 2025
Jan 2, 2025
Feb 20, 2025
Feb 20, 2025
Feb 16, 2025
Dec 27, 2024

Repository files navigation

@zayne-labs/toolkit

A powerful collection of utility functions, types, and composables designed to accelerate development across various JavaScript/TypeScript projects. Built with modularity and type-safety in mind.

πŸ“¦ Packages

  • @zayne-labs/toolkit - Umbrella package that includes all toolkit packages
  • @zayne-labs/toolkit-core - Core utility functions and helpers
  • @zayne-labs/toolkit-type-helpers - Advanced TypeScript type utilities and helpers
  • @zayne-labs/toolkit-react - React-specific hooks, utilities, and Zustand integrations

✨ Features

  • 🎯 Modular design - Import only what you need
  • πŸ“ Full TypeScript support with advanced type utilities
  • βš›οΈ React hooks and utilities for common patterns
  • πŸ”„ Zustand store integrations and helpers
  • 🎨 Zero runtime overhead for type utilities
  • πŸ“¦ Tree-shakeable exports
  • πŸ§ͺ Thoroughly tested utilities
  • πŸ”œ Support for Vue, Svelte, and Solid coming soon!

πŸ“₯ Installation

# Using pnpm (recommended)
pnpm add @zayne-labs/toolkit

# Using npm
npm install @zayne-labs/toolkit

# Using yarn
yarn add @zayne-labs/toolkit

πŸš€ Quick Start

// Core utilities
import { someUtil } from '@zayne-labs/toolkit/core'

// React hooks
import { useToggle } from '@zayne-labs/toolkit/react'

// React utilities
import { cn } from '@zayne-labs/toolkit/react/utils'

// Zustand utilities
import { createStore } from '@zayne-labs/toolkit/react/zustand'

// Type helpers
import type { Prettify } from '@zayne-labs/toolkit/type-helpers'

πŸ› οΈ Development

This project uses pnpm as the package manager. To get started with development:

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run development build
pnpm build:dev

# Run tests
pnpm build:test

# Lint code
pnpm lint:eslint

# Format code
pnpm lint:format

πŸ“ Project Structure

toolkit/
β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ toolkit/          # Main package that exports all utilities
β”‚   β”œβ”€β”€ toolkit-core/     # Core JavaScript/TypeScript utilities
β”‚   β”œβ”€β”€ toolkit-react/    # React-specific hooks and utilities
β”‚   └── toolkit-type-helpers/  # TypeScript type utilities
β”œβ”€β”€ dev/                  # Development utilities
└── package.json         # Root package.json

🀝 Contributing

We welcome contributions! Please check out our contribution guidelines for details on how to get started.

πŸ“„ License

MIT Β© [Ryan Zayne]


About

A collection of utility functions, types and composables. Nothing too fancy, but could be useful

Resources

Code of conduct

Stars

Watchers

Forks

Languages