@carefully-built/saas-kit

中文文档
0.1.47发布于 2026/11/07MITTypeScriptES Module近 30 天下载 5831

One-install Carefully Built SaaS Kit package for React, Next.js, Convex, WorkOS, and editable SaaS components.

原始使用文档
文档目录7 节
  1. Component Previews
  2. Install
  3. Package Modules
  4. Full UI Registry
  5. Editable Source With The CLI
  6. Import vs Eject
  7. Copy And Localization

@carefully-built/saas-kit

One install for Carefully Built SaaS components, product surfaces, and helpers.

Carefully Built SaaS Kit exists so every new B2B product does not have to reinvent the same tables, forms, filters, sheets, settings, files, notifications, calendars, and dashboard patterns from scratch.

Use this package when you want managed npm imports and shared upgrades across apps. Use @carefully-built/cli when you want to eject editable component source into an app.

Component Previews

Smart Table Responsive Sheet Kanban Charts Notifications Search Calendar Maps Superadmin Widgets Files Theme

Install

bun add @carefully-built/saas-kit
import { Button, SmartTable, TableToolbar, ResponsiveSheet } from "@carefully-built/saas-kit";

The package includes the modular Carefully Built packages as dependencies. Your app should still install the framework peer dependencies it actually uses, such as React, Next.js, Convex, WorkOS, Radix primitives, React Hook Form, TipTap, FullCalendar, and Recharts.

Package Modules

Import from the root for shared UI primitives, or from a subpath for a product area.

ModuleUse for
@carefully-built/saas-kitShared UI primitives, table tools, overlays, empty states, error pages, hooks, and utilities
@carefully-built/saas-kit/agendaCalendar and agenda surfaces
@carefully-built/saas-kit/app-shellDashboard shell, responsive navigation, page layouts, and mobile bottom navigation
@carefully-built/saas-kit/association-pickerSearchable association selection
@carefully-built/saas-kit/auth-pagesAuth forms, controllers, pages, social login, organizations, and WorkOS auth UI
@carefully-built/saas-kit/automationsAutomation builder state, canvas, options, and draft helpers
@carefully-built/saas-kit/chartsDashboard chart widgets
@carefully-built/saas-kit/convex-crudConvex CRUD helpers
@carefully-built/saas-kit/convex-multitenantConvex multitenancy helpers
@carefully-built/saas-kit/convex-platformConvex platform association helpers
@carefully-built/saas-kit/convex-workosConvex WorkOS integration helpers
@carefully-built/saas-kit/crudCRUD table/page state and URL filters
@carefully-built/saas-kit/custom-fieldsCustom field definitions and inputs
@carefully-built/saas-kit/filesDocument cards, grids, uploads, and file filtering
@carefully-built/saas-kit/formsSchema/custom forms and user picker fields
@carefully-built/saas-kit/import-exportCSV import/export helpers and sheets
@carefully-built/saas-kit/kanbanKanban board and pipeline helpers
@carefully-built/saas-kit/legal-uiLegal document renderer and default legal text
@carefully-built/saas-kit/maps-uiGoogle Maps Places loader helpers
@carefully-built/saas-kit/notesNotes CRUD page and note list types
@carefully-built/saas-kit/notificationsNotification lists, buttons, and visual metadata
@carefully-built/saas-kit/resource-kitResource pages, entity detail shells, associated tabs, and toast helpers
@carefully-built/saas-kit/rich-textRich text editor and renderer
@carefully-built/saas-kit/searchSearch and command palette modules
@carefully-built/saas-kit/settings-uiSettings cards and settings tab surfaces
@carefully-built/saas-kit/superadminSuperadmin UI, server helpers, and Next.js page factory
@carefully-built/saas-kit/theme-uiTheme selector components
@carefully-built/saas-kit/uiDirect access to the UI package barrel
@carefully-built/saas-kit/user-pickerUser picker package barrel
@carefully-built/saas-kit/widgetsDashboard widget wrappers
@carefully-built/saas-kit/workosWorkOS organization UI and server helpers
@carefully-built/saas-kit/serverServer-only helpers
@carefully-built/saas-kit/nextNext.js helpers

Example subpath imports:

import { DashboardPageLayout } from "@carefully-built/saas-kit/app-shell";
import { AuthLoginPage } from "@carefully-built/saas-kit/auth-pages/pages";
import { createWorkOSWidgetTokenResponse } from "@carefully-built/saas-kit/server";
import { createSuperAdminPage } from "@carefully-built/saas-kit/next";

Full UI Registry

Every public UI module exported by @carefully-built/ui is available through @carefully-built/saas-kit and through the CLI registry.

Registry entryManaged importEditable source
avatarimport { Avatar, AvatarFallback, AvatarImage } from "@carefully-built/saas-kit"bunx @carefully-built/cli add avatar
buttonimport { Button, ButtonSize, ButtonVariant, buttonVariants } from "@carefully-built/saas-kit"bunx @carefully-built/cli add button
calendarimport { Calendar } from "@carefully-built/saas-kit"bunx @carefully-built/cli add calendar
cardimport { Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle } from "@carefully-built/saas-kit"bunx @carefully-built/cli add card
chipimport { Chip, ChipButton } from "@carefully-built/saas-kit"bunx @carefully-built/cli add chip
chip-utilsimport { CHIP_CLASS_NAMES, ChipSize, getChipClassName } from "@carefully-built/saas-kit"bunx @carefully-built/cli add chip-utils
date-displayimport { DateDisplayValue, formatAbsoluteDate, formatDisplayDate } from "@carefully-built/saas-kit"bunx @carefully-built/cli add date-display
dialogimport { Dialog, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay } from "@carefully-built/saas-kit"bunx @carefully-built/cli add dialog
display-dateimport { DisplayDate } from "@carefully-built/saas-kit"bunx @carefully-built/cli add display-date
drawerimport { Drawer, DrawerContent, DrawerDescription, DrawerHeader, DrawerOverlay, DrawerPortal } from "@carefully-built/saas-kit"bunx @carefully-built/cli add drawer
dropdown-menuimport { DropdownMenu, DropdownMenuCheckboxItem, DropdownMenuContent, DropdownMenuItem, DropdownMenuLabel, DropdownMenuSeparator } from "@carefully-built/saas-kit"bunx @carefully-built/cli add dropdown-menu
empty-stateimport { CollectionEmptyState, EmptyStateCard, InitialEmptyState, NoResultsState, ResolveCollectionEmptyStateOptions, resolveCollectionEmptyState } from "@carefully-built/saas-kit"bunx @carefully-built/cli add empty-state
error-pageimport { ErrorCode, ErrorPageContent, ErrorPageKind, PostHogErrorCapturePayload, ResolveErrorPageContentOptions, SaasErrorPage } from "@carefully-built/saas-kit"bunx @carefully-built/cli add error-page
field-detail-rowimport { FieldDetailRow } from "@carefully-built/saas-kit"bunx @carefully-built/cli add field-detail-row
file-dropzoneimport { FileDropzone } from "@carefully-built/saas-kit"bunx @carefully-built/cli add file-dropzone
help-info-buttonimport { HelpInfoButton } from "@carefully-built/saas-kit"bunx @carefully-built/cli add help-info-button
inputimport { Input } from "@carefully-built/saas-kit"bunx @carefully-built/cli add input
keyboard-shortcut-hintimport { KeyboardKeycap, ShortcutModifierKeycap } from "@carefully-built/saas-kit"bunx @carefully-built/cli add keyboard-shortcut-hint
labelimport { Label } from "@carefully-built/saas-kit"bunx @carefully-built/cli add label
paginationimport { Pagination } from "@carefully-built/saas-kit"bunx @carefully-built/cli add pagination
popoverimport { Popover, PopoverContent, PopoverTrigger } from "@carefully-built/saas-kit"bunx @carefully-built/cli add popover
responsive-sheetimport { ResponsiveSheet, SheetOutsideInteractionGuard } from "@carefully-built/saas-kit"bunx @carefully-built/cli add responsive-sheet
responsive-sheet.footerimport { DesktopConfirmShortcutHint, SheetActionFooter } from "@carefully-built/saas-kit"bunx @carefully-built/cli add responsive-sheet.footer
responsive-sheet.shortcutsimport { getDesktopShortcutModifierLabel, isAllowedConfirmShortcutEvent, useDesktopConfirmShortcut, useDesktopShortcutModifierLabel } from "@carefully-built/saas-kit"bunx @carefully-built/cli add responsive-sheet.shortcuts
scroll-fade-areaimport { ScrollFadeArea } from "@carefully-built/saas-kit"bunx @carefully-built/cli add scroll-fade-area
searchimport { SearchTextPart, buildSearchText, filterAndRankBySearch, rankBySearch, scoreFuzzyMatch } from "@carefully-built/saas-kit"bunx @carefully-built/cli add search
searchable-selectimport { AUTO_SEARCHABLE_SELECT_THRESHOLD, SearchableSelect, SearchableSelectOption, getSearchableSelectPortalContainer, isSearchableSelectPointerInside } from "@carefully-built/saas-kit"bunx @carefully-built/cli add searchable-select
searchable-select-positionimport { SearchableSelectRect, resolveSearchableSelectDropdownPosition } from "@carefully-built/saas-kit"bunx @carefully-built/cli add searchable-select-position
segmented-toggleimport { SegmentedToggle, SegmentedToggleOption } from "@carefully-built/saas-kit"bunx @carefully-built/cli add segmented-toggle
selectimport { Select, SelectContent, SelectItem, SelectScrollDownButton, SelectScrollUpButton, SelectTrigger } from "@carefully-built/saas-kit"bunx @carefully-built/cli add select
sheetimport { Sheet, SheetContent, SheetDescription, SheetHeader, SheetTitle } from "@carefully-built/saas-kit"bunx @carefully-built/cli add sheet
skeletonimport { Skeleton } from "@carefully-built/saas-kit"bunx @carefully-built/cli add skeleton
smart-tableimport { ActionHandlers, ActionType, Column, ColumnAlign, PaginationConfig, SmartTable } from "@carefully-built/saas-kit"bunx @carefully-built/cli add smart-table
switchimport { Switch } from "@carefully-built/saas-kit"bunx @carefully-built/cli add switch
tableimport { Table, TableBody, TableCaption, TableCell, TableFooter, TableHead } from "@carefully-built/saas-kit"bunx @carefully-built/cli add table
table-toolbarimport { CustomTableToolbarFilter, FilterConfig, FilterDropdown, FilterOption, SearchInput, TableToolbar } from "@carefully-built/saas-kit"bunx @carefully-built/cli add table-toolbar
tabsimport { Tabs, TabsContent, TabsList, TabsScrollArea, TabsTrigger, tabsListVariants } from "@carefully-built/saas-kit"bunx @carefully-built/cli add tabs
textareaimport { Textarea } from "@carefully-built/saas-kit"bunx @carefully-built/cli add textarea
tooltipimport { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from "@carefully-built/saas-kit"bunx @carefully-built/cli add tooltip
use-media-queryimport { useIsMobile, useMediaQuery } from "@carefully-built/saas-kit"bunx @carefully-built/cli add use-media-query
user-pickerimport { UserPicker } from "@carefully-built/saas-kit"bunx @carefully-built/cli add user-picker
user-picker-utilsimport { UserPickerCopy, UserPickerOption, buildUserInitials, filterSelectableUsers, filterUsersBySearch, formatSelectedUserSummary } from "@carefully-built/saas-kit"bunx @carefully-built/cli add user-picker-utils

Some entries export several related components, hooks, helpers, and types from one module. TypeScript autocomplete will show the full API after installing the kit.

Editable Source With The CLI

Use the CLI when a component should become local code that you can edit directly.

bunx @carefully-built/cli list
bunx @carefully-built/cli add button
bunx @carefully-built/cli add smart-table
bunx @carefully-built/cli add responsive-sheet

The CLI copies the component source and its local dependency closure into your app. It reads common shadcn project conventions such as components.json aliases and tsconfig.json paths.

Import vs Eject

Import from @carefully-built/saas-kit when:

  • you want package updates and bug fixes
  • the component should stay shared across apps
  • product-specific differences can be handled with props, slots, className, or classes

Use @carefully-built/cli add when:

  • the component needs local product behavior
  • design needs to diverge from the shared package
  • you want to own and edit every line in the consuming app
  • the component should follow the app's normal source-control workflow

Copy And Localization

Every user-facing string is still a label/config prop. Defaults follow the kit locale: English without a provider, Italian with KitLocaleProvider:

import { KitLocaleProvider } from '@carefully-built/saas-kit';

<KitLocaleProvider locale="it">{children}</KitLocaleProvider>;

Localized so far: ui (overlays, table toolbar, searchable select, empty and error states, file dropzone, user picker), forms fields, auth-pages (pages, forms, social buttons, organization selection, legal consent, validation) and the search command palette. Server-side auth action messages stay in config.messages.

版本与发布记录

@carefully-built/saas-kit 共发布 47 个版本,首次发布于 2026/06/24;过去 12 个月发布了 47 个版本。

版本发布日期距今
0.1.47latest2026/11/072 天前
0.1.462026/11/072 天前
0.1.452026/11/072 天前
0.1.442026/11/072 天前
0.1.432026/11/072 天前
0.1.422026/11/072 天前

关于 @carefully-built/saas-kit 的常见问题

@carefully-built/saas-kit 是什么?

One-install Carefully Built SaaS Kit package for React, Next.js, Convex, WorkOS, and editable SaaS components.

如何安装 @carefully-built/saas-kit?

在项目目录运行 npm install @carefully-built/saas-kit,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(>=4.0.0)、clsx(>=2.0.0)、next(>=15.0.0 || >=16.0.0)、nuqs(>=2.0.0)、vaul(>=1.0.0)、react(^18.0.0 || ^19.0.0)、convex(>=1.0.0)、sonner(>=1.0.0 || >=2.0.0)、date-fns(>=4.0.0)、radix-ui(>=1.0.0)、recharts(>=2.0.0)、papaparse(^5.0.0)、react-dom(^18.0.0 || ^19.0.0)、lucide-react(>=0.400.0 || >=1.0.0)、@tiptap/react(>=3.0.0)、@xyflow/react(^12.10.2)、tailwind-merge(>=2.0.0 || >=3.0.0)、react-hook-form(>=7.0.0)、react-day-picker(>=9.0.0)、@fullcalendar/core(^6.1.0)、react-country-flag(>=3.0.0)、@fullcalendar/react(^6.1.0)、@hookform/resolvers(>=5.0.0)、@tiptap/starter-kit(>=3.0.0)、@radix-ui/react-slot(^1.0.0)、@fullcalendar/daygrid(^6.1.0)、@fullcalendar/timegrid(^6.1.0)、@tiptap/extension-link(>=3.0.0)、@tiptap/extension-table(>=3.0.0)、class-variance-authority(>=0.7.0)、react-phone-number-input(>=3.0.0)、@fullcalendar/interaction(^6.1.0)、@tiptap/extension-table-row(>=3.0.0)、@tiptap/extension-table-cell(>=3.0.0)、@tiptap/extension-table-header(>=3.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@carefully-built/saas-kit 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@carefully-built/saas-kit 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@carefully-built/saas-kit 可以商用吗?

@carefully-built/saas-kit 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@carefully-built/saas-kit 的下载量有多少?

根据 npm 官方下载统计,@carefully-built/saas-kit 在 2026/10/09 – 2026/11/07 这 30 天内被下载 5,831 次,日均约 194 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@carefully-built/saas-kit 还在维护吗?

最新版本 0.1.47 发布于 2026/11/07(2 天前);至今共发布 47 个版本,其中过去 12 个月发布了 47 个;首次发布于 2026/06/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。