lark-docs-variables 1.0.0

package/src/components/base/Combobox.tsx

@@ -0,0 +1,217 @@
+import { Button } from '@/components/base/Button'
+import { InputGroup, InputGroupAddon, InputGroupButton, InputGroupInput } from '@/components/base/InputGroup'
+import { cn } from '@/lib/utils'
+import { Combobox as ComboboxPrimitive } from '@base-ui/react'
+import { CheckIcon, ChevronDownIcon, XIcon } from 'lucide-react'
+import { ComponentPropsWithRef, FunctionComponent } from 'react'
+
+const Combobox = ComboboxPrimitive.Root
+
+export const ComboboxValue: FunctionComponent<ComboboxPrimitive.Value.Props> = ({ ...props }) => {
+  return <ComboboxPrimitive.Value data-slot='combobox-value' {...props} />
+}
+
+export const ComboboxTrigger: FunctionComponent<ComboboxPrimitive.Trigger.Props> = ({
+  className,
+  children,
+  ...props
+}) => {
+  return (
+    <ComboboxPrimitive.Trigger
+      data-slot='combobox-trigger'
+      className={cn('[&_svg:not([class*=\'size-\'])]:size-4', className)}
+      {...props}>
+      {children}
+      <ChevronDownIcon className='text-muted-foreground size-4 pointer-events-none' />
+    </ComboboxPrimitive.Trigger>
+  )
+}
+
+const ComboboxClear: FunctionComponent<ComboboxPrimitive.Clear.Props> = ({ className, ...props }) => {
+  return (
+    <ComboboxPrimitive.Clear
+      data-slot='combobox-clear'
+      render={<InputGroupButton variant='ghost' size='icon-xs' />}
+      className={cn(className)}
+      {...props}>
+      <XIcon className='pointer-events-none' />
+    </ComboboxPrimitive.Clear>
+  )
+}
+
+export const ComboboxInput: FunctionComponent<
+  ComboboxPrimitive.Input.Props & { showTrigger?: boolean; showClear?: boolean }
+> = ({ className, children, disabled = false, showTrigger = true, showClear = false, ...props }) => {
+  return (
+    <InputGroup className={cn('w-auto', className)}>
+      <ComboboxPrimitive.Input render={<InputGroupInput disabled={disabled} />} {...props} />
+      <InputGroupAddon align='inline-end'>
+        {showTrigger && (
+          <InputGroupButton
+            size='icon-xs'
+            variant='ghost'
+            render={<ComboboxTrigger />}
+            data-slot='input-group-button'
+            className='group-has-data-[slot=combobox-clear]/input-group:hidden data-pressed:bg-transparent'
+            disabled={disabled}
+          />
+        )}
+        {showClear && <ComboboxClear disabled={disabled} />}
+      </InputGroupAddon>
+      {children}
+    </InputGroup>
+  )
+}
+
+export const ComboboxContent: FunctionComponent<
+  ComboboxPrimitive.Popup.Props &
+  Pick<ComboboxPrimitive.Positioner.Props, 'side' | 'align' | 'sideOffset' | 'alignOffset' | 'anchor'>
+> = ({ className, side = 'bottom', sideOffset = 6, align = 'start', alignOffset = 0, anchor, ...props }) => {
+  return (
+    <ComboboxPrimitive.Portal>
+      <ComboboxPrimitive.Positioner
+        side={side}
+        sideOffset={sideOffset}
+        align={align}
+        alignOffset={alignOffset}
+        anchor={anchor}
+        className='isolate z-50'>
+        <ComboboxPrimitive.Popup
+          data-slot='combobox-content'
+          data-chips={!!anchor}
+          className={cn(
+            'bg-popover text-popover-foreground data-open:animate-in data-closed:animate-out data-closed:fade-out-0 data-open:fade-in-0 data-closed:zoom-out-95 data-open:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 ring-foreground/10 *:data-[slot=input-group]:bg-input/30 *:data-[slot=input-group]:border-input/30 max-h-72 min-w-36 overflow-hidden rounded-md shadow-md ring-1 duration-100 *:data-[slot=input-group]:m-1 *:data-[slot=input-group]:mb-0 *:data-[slot=input-group]:h-8 *:data-[slot=input-group]:shadow-none data-[side=inline-start]:slide-in-from-right-2 data-[side=inline-end]:slide-in-from-left-2 group/combobox-content relative w-(--anchor-width) max-w-(--available-width) origin-(--transform-origin) data-[chips=true]:min-w-(--anchor-width)',
+            className
+          )}
+          {...props}
+        />
+      </ComboboxPrimitive.Positioner>
+    </ComboboxPrimitive.Portal>
+  )
+}
+
+export const ComboboxList: FunctionComponent<ComboboxPrimitive.List.Props> = ({ className, ...props }) => {
+  return (
+    <ComboboxPrimitive.List
+      data-slot='combobox-list'
+      className={cn(
+        'no-scrollbar max-h-[min(calc(--spacing(72)---spacing(9)),calc(var(--available-height)---spacing(9)))] scroll-py-1 overflow-y-auto p-1 data-empty:p-0 overscroll-contain',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+export const ComboboxItem: FunctionComponent<ComboboxPrimitive.Item.Props> = ({ className, children, ...props }) => {
+  return (
+    <ComboboxPrimitive.Item
+      data-slot='combobox-item'
+      className={cn(
+        'data-highlighted:bg-accent data-highlighted:text-accent-foreground not-data-[variant=destructive]:data-highlighted:**:text-accent-foreground gap-2 rounded-sm py-1.5 pr-8 pl-2 text-sm [&_svg:not([class*=\'size-\'])]:size-4 relative flex w-full cursor-default items-center outline-hidden select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0',
+        className
+      )}
+      {...props}>
+      {children}
+      <ComboboxPrimitive.ItemIndicator
+        render={<span className='pointer-events-none absolute right-2 flex size-4 items-center justify-center' />}>
+        <CheckIcon className='pointer-events-none' />
+      </ComboboxPrimitive.ItemIndicator>
+    </ComboboxPrimitive.Item>
+  )
+}
+
+export const ComboboxGroup: FunctionComponent<ComboboxPrimitive.Group.Props> = ({ className, ...props }) => {
+  return <ComboboxPrimitive.Group data-slot='combobox-group' className={cn(className)} {...props} />
+}
+
+export const ComboboxLabel: FunctionComponent<ComboboxPrimitive.GroupLabel.Props> = ({ className, ...props }) => {
+  return (
+    <ComboboxPrimitive.GroupLabel
+      data-slot='combobox-label'
+      className={cn('text-muted-foreground px-2 py-1.5 text-xs', className)}
+      {...props}
+    />
+  )
+}
+
+export const ComboboxCollection: FunctionComponent<ComboboxPrimitive.Collection.Props> = ({ ...props }) => {
+  return <ComboboxPrimitive.Collection data-slot='combobox-collection' {...props} />
+}
+
+export const ComboboxEmpty: FunctionComponent<ComboboxPrimitive.Empty.Props> = ({ className, ...props }) => {
+  return (
+    <ComboboxPrimitive.Empty
+      data-slot='combobox-empty'
+      className={cn(
+        'text-muted-foreground hidden w-full justify-center py-2 text-center text-sm group-data-empty/combobox-content:flex',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+export const ComboboxSeparator: FunctionComponent<ComboboxPrimitive.Separator.Props> = ({ className, ...props }) => {
+  return (
+    <ComboboxPrimitive.Separator
+      data-slot='combobox-separator'
+      className={cn('bg-border -mx-1 my-1 h-px', className)}
+      {...props}
+    />
+  )
+}
+
+export const ComboboxChips: FunctionComponent<
+  ComponentPropsWithRef<typeof ComboboxPrimitive.Chips> & ComboboxPrimitive.Chips.Props
+> = ({ className, ...props }) => {
+  return (
+    <ComboboxPrimitive.Chips
+      data-slot='combobox-chips'
+      className={cn(
+        'dark:bg-input/30 border-input focus-within:border-ring focus-within:ring-ring/50 has-aria-invalid:ring-destructive/20 dark:has-aria-invalid:ring-destructive/40 has-aria-invalid:border-destructive dark:has-aria-invalid:border-destructive/50 flex min-h-9 flex-wrap items-center gap-1.5 rounded-md border bg-transparent bg-clip-padding px-2.5 py-1.5 text-sm shadow-xs transition-[color,box-shadow] focus-within:ring-[3px] has-aria-invalid:ring-[3px] has-data-[slot=combobox-chip]:px-1.5',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+export const ComboboxChip: FunctionComponent<ComboboxPrimitive.Chip.Props & { showRemove?: boolean }> = ({
+  className,
+  children,
+  showRemove = true,
+  ...props
+}) => {
+  return (
+    <ComboboxPrimitive.Chip
+      data-slot='combobox-chip'
+      className={cn(
+        'bg-muted text-foreground flex h-[calc(--spacing(5.5))] w-fit items-center justify-center gap-1 rounded-sm px-1.5 text-xs font-medium whitespace-nowrap has-data-[slot=combobox-chip-remove]:pr-0 has-disabled:pointer-events-none has-disabled:cursor-not-allowed has-disabled:opacity-50',
+        className
+      )}
+      {...props}>
+      {children}
+      {showRemove && (
+        <ComboboxPrimitive.ChipRemove
+          render={<Button variant='ghost' size='icon-xs' />}
+          className='-ml-1 opacity-50 hover:opacity-100'
+          data-slot='combobox-chip-remove'>
+          <XIcon className='pointer-events-none' />
+        </ComboboxPrimitive.ChipRemove>
+      )}
+    </ComboboxPrimitive.Chip>
+  )
+}
+
+export const ComboboxChipsInput: FunctionComponent<ComboboxPrimitive.Input.Props> = ({ className, ...props }) => {
+  return (
+    <ComboboxPrimitive.Input
+      data-slot='combobox-chip-input'
+      className={cn('min-w-16 flex-1 outline-none', className)}
+      {...props}
+    />
+  )
+}
+
+export { Combobox }

package/src/components/base/Input.tsx

@@ -0,0 +1,17 @@
+import { cn } from '@/lib/utils'
+import { Input as InputPrimitive } from '@base-ui/react/input'
+import { ComponentProps, FunctionComponent } from 'react'
+
+export const Input: FunctionComponent<ComponentProps<'input'>> = ({ className, type, ...props }) => {
+  return (
+    <InputPrimitive
+      type={type}
+      data-slot='input'
+      className={cn(
+        'dark:bg-input/30 border-input focus-visible:border-ring focus-visible:ring-ring/50 aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive dark:aria-invalid:border-destructive/50 h-9 rounded-md border bg-transparent px-2.5 py-1 text-base shadow-xs transition-[color,box-shadow] file:h-7 file:text-sm file:font-medium focus-visible:ring-[3px] aria-invalid:ring-[3px] md:text-sm file:text-foreground placeholder:text-muted-foreground w-full min-w-0 outline-none file:inline-flex file:border-0 file:bg-transparent disabled:pointer-events-none disabled:cursor-not-allowed disabled:opacity-50',
+        className
+      )}
+      {...props}
+    />
+  )
+}

package/src/components/base/InputGroup.tsx

@@ -0,0 +1,123 @@
+'use client'
+
+import { Button } from '@/components/base/Button'
+import { Input } from '@/components/base/Input'
+import { Textarea } from '@/components/base/Textarea'
+import { cn } from '@/lib/utils'
+import { VariantProps, cva } from 'class-variance-authority'
+import { ComponentProps, FunctionComponent } from 'react'
+
+export const InputGroup: FunctionComponent<ComponentProps<'div'>> = ({ className, ...props }) => {
+  return (
+    <div
+      data-slot='input-group'
+      role='group'
+      className={cn(
+        'border-input dark:bg-input/30 has-[[data-slot=input-group-control]:focus-visible]:border-ring has-[[data-slot=input-group-control]:focus-visible]:ring-ring/50 has-[[data-slot][aria-invalid=true]]:ring-destructive/20 has-[[data-slot][aria-invalid=true]]:border-destructive dark:has-[[data-slot][aria-invalid=true]]:ring-destructive/40 h-9 rounded-md border shadow-xs transition-[color,box-shadow] has-[[data-slot=input-group-control]:focus-visible]:ring-[3px] has-[[data-slot][aria-invalid=true]]:ring-[3px] has-[>[data-align=block-end]]:h-auto has-[>[data-align=block-end]]:flex-col has-[>[data-align=block-start]]:h-auto has-[>[data-align=block-start]]:flex-col has-[>[data-align=block-end]]:[&>input]:pt-3 has-[>[data-align=block-start]]:[&>input]:pb-3 has-[>[data-align=inline-end]]:[&>input]:pr-1.5 has-[>[data-align=inline-start]]:[&>input]:pl-1.5 in-data-[slot=combobox-content]:focus-within:border-inherit in-data-[slot=combobox-content]:focus-within:ring-0 group/input-group relative flex w-full min-w-0 items-center outline-none has-[>textarea]:h-auto',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+const inputGroupAddonVariants = cva(
+  'text-muted-foreground h-auto gap-2 py-1.5 text-sm font-medium group-data-[disabled=true]/input-group:opacity-50 [&>kbd]:rounded-[calc(var(--radius)-5px)] [&>svg:not([class*=\'size-\'])]:size-4 flex cursor-text items-center justify-center select-none',
+  {
+    variants: {
+      align: {
+        'inline-start': 'pl-2 has-[>button]:ml-[-0.25rem] has-[>kbd]:ml-[-0.15rem] order-first',
+        'inline-end': 'pr-2 has-[>button]:mr-[-0.25rem] has-[>kbd]:mr-[-0.15rem] order-last',
+        'block-start':
+          'px-2.5 pt-2 group-has-[>input]/input-group:pt-2 [.border-b]:pb-2 order-first w-full justify-start',
+        'block-end': 'px-2.5 pb-2 group-has-[>input]/input-group:pb-2 [.border-t]:pt-2 order-last w-full justify-start'
+      }
+    },
+    defaultVariants: { align: 'inline-start' }
+  }
+)
+
+export const InputGroupAddon: FunctionComponent<
+  ComponentProps<'div'> & VariantProps<typeof inputGroupAddonVariants>
+> = ({ className, align = 'inline-start', ...props }) => {
+  return (
+    <div
+      role='group'
+      data-slot='input-group-addon'
+      data-align={align}
+      className={cn(inputGroupAddonVariants({ align }), className)}
+      onClick={(e) => {
+        if ((e.target as HTMLElement).closest('button')) {
+          return
+        }
+        e.currentTarget.parentElement?.querySelector('input')?.focus()
+      }}
+      {...props}
+    />
+  )
+}
+
+const inputGroupButtonVariants = cva('gap-2 text-sm shadow-none flex items-center', {
+  variants: {
+    size: {
+      'xs': 'h-6 gap-1 rounded-[calc(var(--radius)-5px)] px-1.5 [&>svg:not([class*=\'size-\'])]:size-3.5',
+      'sm': '',
+      'icon-xs': 'size-6 rounded-[calc(var(--radius)-5px)] p-0 has-[>svg]:p-0',
+      'icon-sm': 'size-8 p-0 has-[>svg]:p-0'
+    }
+  },
+  defaultVariants: { size: 'xs' }
+})
+
+export const InputGroupButton: FunctionComponent<
+  Omit<ComponentProps<typeof Button>, 'size' | 'type'> &
+  VariantProps<typeof inputGroupButtonVariants> & { type?: 'button' | 'submit' | 'reset' }
+> = ({ className, type = 'button', variant = 'ghost', size = 'xs', ...props }) => {
+  return (
+    <Button
+      type={type}
+      data-size={size}
+      variant={variant}
+      className={cn(inputGroupButtonVariants({ size }), className)}
+      {...props}
+    />
+  )
+}
+
+export const InputGroupText: FunctionComponent<ComponentProps<'span'>> = ({ className, ...props }) => {
+  return (
+    <span
+      className={cn(
+        'text-muted-foreground gap-2 text-sm [&_svg:not([class*=\'size-\'])]:size-4 flex items-center [&_svg]:pointer-events-none',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+export const InputGroupInput: FunctionComponent<ComponentProps<'input'>> = ({ className, ...props }) => {
+  return (
+    <Input
+      data-slot='input-group-control'
+      className={cn(
+        'rounded-none border-0 bg-transparent shadow-none ring-0 focus-visible:ring-0 aria-invalid:ring-0 dark:bg-transparent flex-1',
+        className
+      )}
+      {...props}
+    />
+  )
+}
+
+export const InputGroupTextarea: FunctionComponent<ComponentProps<'textarea'>> = ({ className, ...props }) => {
+  return (
+    <Textarea
+      data-slot='input-group-control'
+      className={cn(
+        'rounded-none border-0 bg-transparent py-2 shadow-none ring-0 focus-visible:ring-0 aria-invalid:ring-0 dark:bg-transparent flex-1 resize-none',
+        className
+      )}
+      {...props}
+    />
+  )
+}

package/src/components/base/Textarea.tsx

@@ -0,0 +1,15 @@
+import { cn } from '@/lib/utils'
+import { ComponentProps, FunctionComponent } from 'react'
+
+export const Textarea: FunctionComponent<ComponentProps<'textarea'>> = ({ className, ...props }) => {
+  return (
+    <textarea
+      data-slot='textarea'
+      className={cn(
+        'border-input dark:bg-input/30 focus-visible:border-ring focus-visible:ring-ring/50 aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive dark:aria-invalid:border-destructive/50 rounded-md border bg-transparent px-2.5 py-2 text-base shadow-xs transition-[color,box-shadow] focus-visible:ring-[3px] aria-invalid:ring-[3px] md:text-sm placeholder:text-muted-foreground flex field-sizing-content min-h-16 w-full outline-none disabled:cursor-not-allowed disabled:opacity-50',
+        className
+      )}
+      {...props}
+    />
+  )
+}

package/src/components/base/Toggle.tsx

@@ -0,0 +1,24 @@
+import { cn } from '@/lib/utils'
+import { Toggle as TogglePrimitive } from '@base-ui/react/toggle'
+import { VariantProps, cva } from 'class-variance-authority'
+import { FunctionComponent } from 'react'
+
+const toggleVariants = cva(
+  'hover:text-foreground aria-pressed:bg-muted focus-visible:border-ring focus-visible:ring-ring/50 aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive gap-1 rounded-md text-sm font-medium transition-[color,box-shadow] [&_svg:not([class*=\'size-\'])]:size-4 group/toggle hover:bg-muted inline-flex items-center justify-center whitespace-nowrap outline-none focus-visible:ring-[3px] disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0',
+  {
+    variants: {
+      variant: { default: 'bg-transparent', outline: 'border-input hover:bg-muted border bg-transparent shadow-xs' },
+      size: { default: 'h-9 min-w-9 px-2', sm: 'h-8 min-w-8 px-1.5', lg: 'h-10 min-w-10 px-2.5' }
+    },
+    defaultVariants: { variant: 'default', size: 'default' }
+  }
+)
+
+export const Toggle: FunctionComponent<TogglePrimitive.Props & VariantProps<typeof toggleVariants>> = ({
+  className,
+  variant = 'default',
+  size = 'default',
+  ...props
+}) => {
+  return <TogglePrimitive data-slot='toggle' className={cn(toggleVariants({ variant, size, className }))} {...props} />
+}

package/src/entries/Panel.module.css

@@ -0,0 +1,33 @@
+.container {
+  background-color: var(--background);
+}
+
+.inner {
+  display: flex;
+  flex-direction: column;
+  border-radius: 8px;
+}
+
+.name {
+  height: 36px !important;
+  min-height: 36px !important;
+  width: 100%;
+  min-width: 0;
+}
+
+.name.expanded {
+  border-bottom-left-radius: 0;
+  border-bottom-right-radius: 0;
+}
+
+.name:hover {
+  box-shadow: 0 0 0 1px var(--ring) inset;
+}
+
+.textarea {
+  resize: none;
+  border-top-left-radius: 0;
+  border-top-right-radius: 0;
+  border-top: none;
+  min-height: 40px;
+}

package/src/entries/Panel.tsx

@@ -0,0 +1,67 @@
+import clsx from 'clsx'
+import { AsteriskSquare, ChevronDown, ChevronUp, Code2, CodeSquare, Text } from 'lucide-react'
+import { FunctionComponent, useState } from 'react'
+import { Button } from '../components/base/Button'
+import { InputGroup, InputGroupAddon, InputGroupInput } from '../components/base/InputGroup'
+import { Textarea } from '../components/base/Textarea'
+import { ValueToggle } from '../components/ValueToggle'
+import { useBlock } from '../hooks/useDocument'
+import { useRecord } from '../hooks/useRecord'
+import { app } from '../util/app'
+import { box } from '../util/box'
+import styles from './Panel.module.css'
+
+export interface BlockData {
+  name: string
+  defaultValue: string
+  required: boolean
+  escape: boolean
+}
+
+export const Panel: FunctionComponent = () => {
+  const { docRef, blockRef } = useBlock()
+  const { record, setRecord } = useRecord<BlockData>({ name: '', defaultValue: '', required: false, escape: false })
+  const [open, setOpen] = useState(false)
+  const expanded = !record.required && open
+  return (
+    <div className={clsx(styles['container'])}>
+      <div className={clsx(styles['inner'])}>
+        <InputGroup className={clsx(styles['name'], expanded && styles['expanded'])}>
+          <InputGroupAddon>
+            <Code2 size={16} color='var(--primary)' />
+          </InputGroupAddon>
+          <InputGroupInput type='text' placeholder='VARIABLE:NAME' style={box({ flex: 1 })}
+            value={record.name}
+            onKeyDown={(event) => {
+              if (event.key === 'Backspace' && record.name.length === 0) {
+                app.Block.removeBlock(blockRef)
+                app.Selection.clearSelection(docRef)
+              }
+            }}
+            onChange={({ target }) => { setRecord((cur) => ({ ...cur, name: target.value.toUpperCase() })) }} />
+          <InputGroupAddon align="inline-end" style={{ marginRight: 0, paddingRight: '0.25rem', gap: 0 }}>
+            {(!record.required && record.defaultValue) && <Text size={16} style={{ marginRight: 6 }} />}
+            <ValueToggle icon={CodeSquare} label={(value) => value ? 'ESC' : 'PLN'}
+              value={record.escape}
+              onChange={(escape) => { setRecord((cur) => ({ ...cur, escape })) }} />
+            <ValueToggle icon={AsteriskSquare} label={(value) => value ? 'REQ' : 'OPT'}
+              value={record.required}
+              onChange={(required) => { setRecord((cur) => ({ ...cur, required })) }} />
+            {/* <Button size='icon-sm' variant='ghost' onClick={() => {
+              app.View.Action.openModal({ title: 'Variable Settings', width: 480, data: { docToken: docRef.docToken } })
+            }}><Settings size={16} /></Button> */}
+            <Button disabled={record.required} size='icon-xs' variant='ghost' onClick={() => { setOpen(!open) }}>
+              {expanded ? <ChevronUp size={16} /> : <ChevronDown size={16} />}
+            </Button>
+          </InputGroupAddon>
+        </InputGroup>
+        {expanded && (
+          <Textarea className={styles['textarea']} placeholder='Default value' rows={1}
+            value={record.defaultValue}
+            onChange={(({ target }) => { setRecord((cur) => ({ ...cur, defaultValue: target.value })) })}
+          />
+        )}
+      </div>
+    </div>
+  )
+}

package/src/entries/Settings.css

@@ -0,0 +1,3 @@
+body {
+  background-color: var(--bg-float) !important;
+}

package/src/entries/Settings.module.css

@@ -0,0 +1,4 @@
+.container {
+  border-top: 1px solid #171717;
+  padding: 24px;
+}

package/src/entries/Settings.tsx

@@ -0,0 +1,14 @@
+import './Settings.css'
+
+import { FunctionComponent } from 'react'
+import { useBlock } from '../hooks/useDocument'
+import styles from './Settings.module.css'
+
+export const Settings: FunctionComponent = () => {
+  const { blockRef } = useBlock()
+  return (
+    <div className={styles['container']}>
+      <pre>{JSON.stringify(blockRef, null, 2)}</pre>
+    </div>
+  )
+}

package/src/globals.d.ts

@@ -0,0 +1 @@
+declare module '*.module.css'

package/src/hooks/useBlockHover.ts

@@ -0,0 +1,20 @@
+import { BlockHoverChangeEvent } from '@lark-opdev/block-docs-addon-api'
+import { useEffect, useState } from 'react'
+import { app } from '../util/app'
+import { useBlock } from './useDocument'
+
+export function useBlockHover() {
+  const [hover, setHover] = useState(false)
+
+  const { blockRef } = useBlock()
+  useEffect(() => {
+    const onHoverChange = (event: BlockHoverChangeEvent) => {
+      if (!blockRef || !event.currBlock) { return }
+      setHover(blockRef.blockId === event.currBlock.id)
+    }
+    app.Events.onBlockHoverChange(onHoverChange)
+    return () => { app.Events.offBlockHoverChange(onHoverChange) }
+  }, [blockRef])
+
+  return hover
+}

package/src/hooks/useDebounce.ts

@@ -0,0 +1,16 @@
+import { DependencyList, useEffect } from 'react'
+import useTimeoutFn from './useTimeoutFn'
+
+export type UseDebounceReturn = [() => boolean | null, () => void]
+
+export default function useDebounce(
+  fn: Function,
+  ms = 0,
+  deps: DependencyList = []
+): UseDebounceReturn {
+  const [isReady, cancel, reset] = useTimeoutFn(fn, ms)
+
+  useEffect(reset, deps)
+
+  return [isReady, cancel]
+}

package/src/hooks/useDocument.ts

@@ -0,0 +1,8 @@
+import { useContext } from 'react'
+import { BlockContext } from '../providers/BlockProvider.context'
+
+export function useBlock() {
+  const context = useContext(BlockContext)
+  if (!context) { throw new Error('useBlock must be used within a BlockProvider') }
+  return context
+}

package/src/hooks/useIsMounted.ts

@@ -0,0 +1,15 @@
+import { useCallback, useEffect, useRef } from 'react'
+
+export function useIsMounted(): () => boolean {
+  const isMounted = useRef(false)
+
+  useEffect(() => {
+    isMounted.current = true
+
+    return () => {
+      isMounted.current = false
+    }
+  }, [])
+
+  return useCallback(() => isMounted.current, [])
+}

package/src/hooks/useRecord.ts

@@ -0,0 +1,33 @@
+import { type RecordData } from '@lark-opdev/block-docs-addon-api'
+import { Dispatch, SetStateAction, useEffect, useRef, useState } from 'react'
+import { app } from '../util/app'
+import useDebounce from './useDebounce'
+
+export type UpdateRecordFn<T extends RecordData> = (value: Partial<T>, path?: string[]) => Promise<T>
+
+export interface UseRecordReturn<T extends RecordData> {
+  record: T
+  setRecord: Dispatch<SetStateAction<T>>
+}
+
+export function useRecord<T extends RecordData>(initialValue: T, delay = 500): UseRecordReturn<T> {
+  const [record, setRecord] = useState<T>(initialValue)
+  const shouldSkip = useRef(true)
+
+  useDebounce(() => {
+    if (shouldSkip.current) {
+      shouldSkip.current = false
+      return
+    }
+    console.info('save')
+    app.Record.setRecord([{ type: 'replace', data: { path: [], value: record } }])
+  }, delay, [record])
+
+  useEffect(() => {
+    app.Record.getRecord().then((value) => {
+      setRecord({ ...initialValue, ...value })
+    })
+  }, [])
+
+  return { record, setRecord }
+}