@simplysm/solid 13.0.85 → 13.0.86

package/docs/hooks.md

@@ -1,146 +0,0 @@
-# Hooks
-
-## useLocalStorage
-
-```typescript
-function useLocalStorage<TValue>(
-  key: string,
-  initialValue?: TValue,
-): [Accessor<TValue | undefined>, StorageSetter<TValue>];
-```
-
-Reactive `localStorage` binding. Returns a signal-like tuple. Automatically serializes/deserializes values as JSON.
-
----
-
-## useSyncConfig
-
-```typescript
-function useSyncConfig<TValue>(
-  key: string,
-  defaultValue: TValue,
-): [Accessor<TValue>, Setter<TValue>, Accessor<boolean>];
-```
-
-Persisted configuration backed by `SyncStorageProvider`. Returns `[value, setValue, ready]`. The `ready` accessor becomes `true` once the stored value has been loaded.
-
----
-
-## useLogger
-
-```typescript
-interface Logger {
-  log(...args: unknown[]): void;
-  info(...args: unknown[]): void;
-  warn(...args: unknown[]): void;
-  error(...args: unknown[]): void;
-  configure(fn: (origin: LogAdapter) => LogAdapter): void;
-}
-
-function useLogger(): Logger;
-```
-
-Access the logging system from `LoggerProvider`. Supports middleware composition via `configure()`.
-
----
-
-## createControllableSignal
-
-```typescript
-function createControllableSignal<TValue>(options: {
-  value: Accessor<TValue>;
-  onChange: Accessor<((value: TValue) => void) | undefined>;
-}): [Accessor<TValue>, (newValue: TValue | ((prev: TValue) => TValue)) => TValue];
-```
-
-Creates a signal that supports both controlled and uncontrolled modes. When `onChange` is provided, the component is controlled; otherwise, internal state is used. This is the primitive behind all form control `value`/`onValueChange` pairs.
-
----
-
-## createControllableStore
-
-```typescript
-function createControllableStore<TValue extends object>(options: {
-  value: () => TValue;
-  onChange: () => ((value: TValue) => void) | undefined;
-}): [TValue, SetStoreFunction<TValue>];
-```
-
-Like `createControllableSignal` but for SolidJS stores (deep reactive objects).
-
----
-
-## createIMEHandler
-
-```typescript
-function createIMEHandler(setValue: (value: string) => void): {
-  composingValue: Accessor<string | null>;
-  handleCompositionStart(): void;
-  handleInput(value: string, isComposing: boolean): void;
-  handleCompositionEnd(value: string): void;
-  flushComposition(): void;
-};
-```
-
-Handles IME composition events (Korean, Chinese, Japanese input). Buffers intermediate composition states and only commits the final value. Used internally by `TextInput` and `Textarea`.
-
----
-
-## createMountTransition
-
-```typescript
-function createMountTransition(
-  open: () => boolean,
-): {
-  mounted: () => boolean;
-  animating: () => boolean;
-  unmount: () => void;
-};
-```
-
-Manages mount/unmount transitions. While `open()` is true, `mounted` and `animating` are true. When `open()` becomes false, `animating` becomes false (triggering CSS transition), and `unmount()` should be called after the transition ends to set `mounted` to false.
-
----
-
-## useRouterLink
-
-```typescript
-interface RouterLinkOptions {
-  href: string;
-  state?: Record<string, unknown>;
-  window?: { width?: number; height?: number };
-}
-
-function useRouterLink(): (options: RouterLinkOptions) => (e: MouseEvent | KeyboardEvent) => void;
-```
-
-Creates click handlers for SolidJS Router navigation. Supports opening links in new windows with specified dimensions via the `window` option.
-
----
-
-## Usage Examples
-
-```typescript
-import {
-  useLocalStorage,
-  useSyncConfig,
-  createControllableSignal,
-  useLogger,
-} from "@simplysm/solid";
-
-// Local storage
-const [theme, setTheme] = useLocalStorage<string>("app-theme", "light");
-
-// Sync config (persisted to SyncStorageProvider)
-const [pageSize, setPageSize, ready] = useSyncConfig("pageSize", 20);
-
-// Logger
-const logger = useLogger();
-logger.info("Application started");
-
-// Controlled/uncontrolled primitive
-const [value, setValue] = createControllableSignal({
-  value: () => props.value,
-  onChange: () => props.onValueChange,
-});
-```

package/docs/layout.md

@@ -1,94 +0,0 @@
-# Layout
-
-## FormGroup
-
-```typescript
-interface FormGroupProps extends JSX.HTMLAttributes<HTMLDivElement> {
-  inline?: boolean;
-}
-```
-
-Groups form fields vertically (default) or horizontally with `inline`.
-
-**Sub-component:** `FormGroup.Item` — `{ label?: JSX.Element } & JSX.HTMLAttributes<HTMLDivElement>`
-
----
-
-## FormTable
-
-```typescript
-interface FormTableProps extends JSX.HTMLAttributes<HTMLTableElement> {}
-```
-
-Arranges form fields in a label-value table layout.
-
-**Sub-components:**
-- `FormTable.Row` — table row
-- `FormTable.Item` — `{ label?: JSX.Element } & JSX.TdHTMLAttributes<HTMLTableCellElement>`
-
----
-
-## Sidebar
-
-```typescript
-interface SidebarProps extends JSX.HTMLAttributes<HTMLElement> {
-  children: JSX.Element;
-}
-```
-
-Collapsible sidebar navigation. Must be wrapped in `Sidebar.Container`.
-
-**Sub-components:**
-- `Sidebar.Container` — layout wrapper that includes both sidebar and main content
-- `Sidebar.Menu` — `{ menus: AppMenu[] }` — renders navigation tree from `AppMenu` data
-- `Sidebar.User` — `{ name: string; icon?: Component; description?: string; menus?: SidebarUserMenu[] }` — user profile section with optional dropdown menus
-
-**Hook:** `useSidebar()` — access sidebar state (collapsed, toggle, etc.)
-
----
-
-## Topbar
-
-```typescript
-interface TopbarProps extends JSX.HTMLAttributes<HTMLElement> {
-  children: JSX.Element;
-}
-```
-
-Top navigation bar. Must be wrapped in `Topbar.Container`.
-
-**Sub-components:**
-- `Topbar.Container` — layout wrapper
-- `Topbar.Menu` — `{ menus: TopbarMenuItem[] }` — renders top-level navigation
-- `Topbar.User` — `{ menus?: TopbarUserMenu[]; children: JSX.Element }` — user section with dropdown
-
-**Hooks:**
-- `useTopbarActionsAccessor()` — access topbar actions element
-- `useTopbarActions(accessor)` — register topbar actions from child components
-
----
-
-## Usage Examples
-
-```typescript
-import { Sidebar, FormGroup, FormTable } from "@simplysm/solid";
-
-// Sidebar layout
-<Sidebar.Container>
-  <Sidebar>
-    <Sidebar.User name="John" description="Admin" />
-    <Sidebar.Menu menus={appMenus} />
-  </Sidebar>
-  <main>Content</main>
-</Sidebar.Container>
-
-// Form with labeled fields
-<FormGroup>
-  <FormGroup.Item label="Name">
-    <TextInput value={name()} onValueChange={setName} />
-  </FormGroup.Item>
-  <FormGroup.Item label="Email">
-    <TextInput value={email()} onValueChange={setEmail} type="email" />
-  </FormGroup.Item>
-</FormGroup>
-```

package/docs/providers.md

@@ -1,180 +0,0 @@
-# Providers
-
-## ConfigProvider
-
-```typescript
-export const ConfigProvider: ParentComponent<{ clientName: string }>;
-export function useConfig(): { clientName: string };
-```
-
-Application-level configuration. `clientName` identifies the client app and is used as a storage key prefix.
-
----
-
-## ThemeProvider
-
-```typescript
-type ThemeMode = "light" | "dark" | "system";
-type ResolvedTheme = "light" | "dark";
-
-interface ThemeContextValue {
-  mode(): ThemeMode;
-  setMode(mode: ThemeMode): void;
-  resolvedTheme(): ResolvedTheme;
-  cycleMode(): void;
-}
-
-export const ThemeProvider: ParentComponent;
-export function useTheme(): ThemeContextValue;
-```
-
-Light/Dark mode management with system preference detection. `cycleMode()` rotates through light -> system -> dark -> light. The selected mode is persisted via `SyncStorageProvider`.
-
----
-
-## I18nProvider
-
-```typescript
-interface I18nContextValue {
-  t(key: string, params?: Record<string, string>): string;
-  locale: Accessor<string>;
-  setLocale(locale: string): void;
-  configure(options: I18nConfigureOptions): void;
-}
-
-interface I18nConfigureOptions {
-  locale?: string;
-  dict?: Record<string, Record<string, unknown>>;
-}
-
-export const I18nProvider: ParentComponent;
-export function useI18n(): I18nContextValue;
-```
-
-Internationalization provider. Built-in dictionaries for `"en"` and `"ko"`. Supports nested dictionary keys and parameter interpolation via `t("key", { name: "John" })`. The locale is auto-detected from `navigator.language` and persisted via `SyncStorageProvider`. Use `configure()` to add or override dictionaries.
-
----
-
-## SyncStorageProvider
-
-```typescript
-interface StorageAdapter {
-  getItem(key: string): string | null | Promise<string | null>;
-  setItem(key: string, value: string): void | Promise<unknown>;
-  removeItem(key: string): void | Promise<void>;
-}
-
-interface SyncStorageContextValue {
-  adapter: Accessor<StorageAdapter>;
-  configure(fn: (origin: StorageAdapter) => StorageAdapter): void;
-}
-
-export const SyncStorageProvider: ParentComponent;
-export function useSyncStorage(): SyncStorageContextValue | undefined;
-```
-
-Pluggable storage adapter used by components like `StatePreset`, `DataSheet` (column config), and `useSyncConfig`. Defaults to `localStorage`. Override with `configure()` for server-backed storage.
-
----
-
-## LoggerProvider
-
-```typescript
-interface LogAdapter {
-  write(severity: "error" | "warn" | "info" | "log", ...data: any[]): Promise<void> | void;
-}
-
-interface LoggerContextValue {
-  adapter: Accessor<LogAdapter>;
-  configure(fn: (origin: LogAdapter) => LogAdapter): void;
-}
-
-export const LoggerProvider: ParentComponent;
-```
-
-Configurable logging provider. Defaults to a `consola`-based adapter. Middleware pattern via `configure()`.
-
----
-
-## ServiceClientProvider
-
-```typescript
-interface ServiceClientContextValue {
-  connect(key?: string, options?: Partial<ServiceConnectionOptions>): Promise<void>;
-  close(key?: string): Promise<void>;
-  get(key?: string): ServiceClient;
-  isConnected(key?: string): boolean;
-}
-
-export const ServiceClientProvider: ParentComponent;
-export function useServiceClient(): ServiceClientContextValue;
-```
-
-Service communication provider. Manages WebSocket connections to backend services. Multiple named connections supported via `key` (defaults to `"default"`). Auto-infers host, port, and SSL from `window.location` when not specified.
-
----
-
-## SharedDataProvider
-
-```typescript
-interface SharedDataDefinition<TData> {
-  serviceKey?: string;
-  fetch(changeKeys?: (string | number)[]): Promise<TData[]>;
-  getKey(item: TData): string | number;
-  orderBy: [(item: TData) => unknown, "asc" | "desc"][];
-  filter?: unknown;
-  itemSearchText?: (item: TData) => string;
-  isItemHidden?: (item: TData) => boolean;
-  getParentKey?: (item: TData) => string | number | undefined;
-}
-
-interface SharedDataAccessor<TData> {
-  items: Accessor<TData[]>;
-  get(key: string | number | undefined): TData | undefined;
-  emit(changeKeys?: (string | number)[]): Promise<void>;
-  getKey(item: TData): string | number;
-  itemSearchText?: (item: TData) => string;
-  isItemHidden?: (item: TData) => boolean;
-  getParentKey?: (item: TData) => string | number | undefined;
-}
-
-export const SharedDataProvider: (props: { children: JSX.Element }) => JSX.Element;
-export function useSharedData<TSharedData>(): SharedDataValue<TSharedData>;
-```
-
-Centralized data management for shared lookup data (e.g. code tables). Data is fetched once and shared across all consumers. `emit()` triggers a re-fetch. Must be used inside `ServiceClientProvider`.
-
-The returned `SharedDataValue` also provides:
-- `wait()` -- wait until all initial fetches complete
-- `busy` -- whether a fetch is in progress
-- `configure()` -- set definitions to start data subscriptions (can only be called once)
-
----
-
-## SystemProvider
-
-```typescript
-export const SystemProvider: ParentComponent<{
-  clientName: string;
-  busyVariant?: BusyVariant;
-}>;
-```
-
-Convenience provider that composes `ConfigProvider`, `I18nProvider`, `SyncStorageProvider`, `LoggerProvider`, `NotificationProvider`, `ErrorLoggerProvider`, `PwaUpdateProvider`, `ClipboardProvider`, `ThemeProvider`, `ServiceClientProvider`, `SharedDataProvider`, and `BusyProvider` into a single wrapper.
-
----
-
-## Usage Examples
-
-```typescript
-import { SystemProvider, DialogProvider, PrintProvider } from "@simplysm/solid";
-
-// Typical app provider tree
-<SystemProvider clientName="my-app">
-  <DialogProvider>
-    <PrintProvider>
-      <App />
-    </PrintProvider>
-  </DialogProvider>
-</SystemProvider>
-```