@betterstart/cli 0.1.3 → 0.1.4

package/templates/tiptap/tiptap-ui/link-popover/use-link-popover.ts

@@ -0,0 +1,286 @@
+'use client'
+
+import type { Editor } from '@tiptap/react'
+import { useCallback, useEffect, useState } from 'react'
+
+// --- Hooks ---
+import { useTiptapEditor } from '../../hooks/use-tiptap-editor'
+// --- Lib ---
+import { isMarkInSchema, isNodeTypeSelected, sanitizeUrl } from '../../lib/tiptap-utils'
+// --- Icons ---
+import { LinkIcon } from '../../tiptap-icons/link-icon'
+
+/**
+ * Configuration for the link popover functionality
+ */
+export interface UseLinkPopoverConfig {
+  /**
+   * The Tiptap editor instance.
+   */
+  editor?: Editor | null
+  /**
+   * Whether to hide the link popover when not available.
+   * @default false
+   */
+  hideWhenUnavailable?: boolean
+  /**
+   * Callback function called when the link is set.
+   */
+  onSetLink?: () => void
+}
+
+/**
+ * Configuration for the link handler functionality
+ */
+export interface LinkHandlerProps {
+  /**
+   * The Tiptap editor instance.
+   */
+  editor: Editor | null
+  /**
+   * Callback function called when the link is set.
+   */
+  onSetLink?: () => void
+}
+
+/**
+ * Checks if a link can be set in the current editor state
+ */
+export function canSetLink(editor: Editor | null): boolean {
+  if (!editor || !editor.isEditable) return false
+
+  // The third argument 'true' checks whether the current selection is inside an image caption, and prevents setting a link there
+  // If the selection is inside an image caption, we can't set a link
+  if (isNodeTypeSelected(editor, ['image'], true)) return false
+  try {
+    return editor.can().setMark('link')
+  } catch {
+    return false
+  }
+}
+
+/**
+ * Checks if a link is currently active in the editor
+ */
+export function isLinkActive(editor: Editor | null): boolean {
+  if (!editor || !editor.isEditable) return false
+  return editor.isActive('link')
+}
+
+/**
+ * Determines if the link button should be shown
+ */
+export function shouldShowLinkButton(props: {
+  editor: Editor | null
+  hideWhenUnavailable: boolean
+}): boolean {
+  const { editor, hideWhenUnavailable } = props
+
+  if (!editor || !editor.isEditable) return false
+
+  const linkInSchema = isMarkInSchema('link', editor)
+
+  // If hideWhenUnavailable is false, always show the button (even if disabled)
+  if (!hideWhenUnavailable) {
+    return true
+  }
+
+  // hideWhenUnavailable is true: hide if link is not in schema
+  if (!linkInSchema) {
+    return false
+  }
+
+  // hideWhenUnavailable is true: hide if we can't set a link (unless in code block)
+  if (!editor.isActive('code')) {
+    return canSetLink(editor)
+  }
+
+  return true
+}
+
+/**
+ * Custom hook for handling link operations in a Tiptap editor
+ */
+export function useLinkHandler(props: LinkHandlerProps) {
+  const { editor, onSetLink } = props
+  const [url, setUrl] = useState<string | null>(null)
+
+  useEffect(() => {
+    if (!editor) return
+
+    // Get URL immediately on mount
+    const { href } = editor.getAttributes('link')
+
+    if (isLinkActive(editor) && url === null) {
+      setUrl(href || '')
+    }
+  }, [editor, url])
+
+  useEffect(() => {
+    if (!editor) return
+
+    const updateLinkState = () => {
+      const { href } = editor.getAttributes('link')
+      setUrl(href || '')
+    }
+
+    editor.on('selectionUpdate', updateLinkState)
+    return () => {
+      editor.off('selectionUpdate', updateLinkState)
+    }
+  }, [editor])
+
+  const setLink = useCallback(() => {
+    if (!url || !editor) return
+
+    const { selection } = editor.state
+    const isEmpty = selection.empty
+
+    let chain = editor.chain().focus()
+
+    chain = chain.extendMarkRange('link').setLink({ href: url })
+
+    if (isEmpty) {
+      chain = chain.insertContent({ type: 'text', text: url })
+    }
+
+    chain.run()
+
+    setUrl(null)
+
+    onSetLink?.()
+  }, [editor, onSetLink, url])
+
+  const removeLink = useCallback(() => {
+    if (!editor) return
+    editor
+      .chain()
+      .focus()
+      .extendMarkRange('link')
+      .unsetLink()
+      .setMeta('preventAutolink', true)
+      .run()
+    setUrl('')
+  }, [editor])
+
+  const openLink = useCallback(
+    (target: string = '_blank', features: string = 'noopener,noreferrer') => {
+      if (!url) return
+
+      const safeUrl = sanitizeUrl(url, window.location.href)
+      if (safeUrl !== '#') {
+        window.open(safeUrl, target, features)
+      }
+    },
+    [url]
+  )
+
+  return {
+    url: url || '',
+    setUrl,
+    setLink,
+    removeLink,
+    openLink
+  }
+}
+
+/**
+ * Custom hook for link popover state management
+ */
+export function useLinkState(props: { editor: Editor | null; hideWhenUnavailable: boolean }) {
+  const { editor, hideWhenUnavailable = false } = props
+
+  const canSet = canSetLink(editor)
+  const isActive = isLinkActive(editor)
+
+  const [isVisible, setIsVisible] = useState(true)
+
+  useEffect(() => {
+    if (!editor) return
+
+    const handleSelectionUpdate = () => {
+      setIsVisible(
+        shouldShowLinkButton({
+          editor,
+          hideWhenUnavailable
+        })
+      )
+    }
+
+    handleSelectionUpdate()
+
+    editor.on('selectionUpdate', handleSelectionUpdate)
+
+    return () => {
+      editor.off('selectionUpdate', handleSelectionUpdate)
+    }
+  }, [editor, hideWhenUnavailable])
+
+  return {
+    isVisible,
+    canSet,
+    isActive
+  }
+}
+
+/**
+ * Main hook that provides link popover functionality for Tiptap editor
+ *
+ * @example
+ * ```tsx
+ * // Simple usage
+ * function MyLinkButton() {
+ *   const { isVisible, canSet, isActive, Icon, label } = useLinkPopover()
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button disabled={!canSet}>Link</button>
+ * }
+ *
+ * // Advanced usage with configuration
+ * function MyAdvancedLinkButton() {
+ *   const { isVisible, canSet, isActive, Icon, label } = useLinkPopover({
+ *     editor: myEditor,
+ *     hideWhenUnavailable: true,
+ *     onSetLink: () => console.log('Link set!')
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <MyButton
+ *       disabled={!canSet}
+ *       aria-label={label}
+ *       aria-pressed={isActive}
+ *     >
+ *       <Icon />
+ *       {label}
+ *     </MyButton>
+ *   )
+ * }
+ * ```
+ */
+export function useLinkPopover(config?: UseLinkPopoverConfig) {
+  const { editor: providedEditor, hideWhenUnavailable = false, onSetLink } = config || {}
+
+  const { editor } = useTiptapEditor(providedEditor)
+
+  const { isVisible, canSet, isActive } = useLinkState({
+    editor,
+    hideWhenUnavailable
+  })
+
+  const linkHandler = useLinkHandler({
+    editor,
+    onSetLink
+  })
+
+  return {
+    isVisible,
+    canSet,
+    isActive,
+    label: 'Link',
+    Icon: LinkIcon,
+    ...linkHandler
+  }
+}

package/templates/tiptap/tiptap-ui/list-button/index.tsx

@@ -0,0 +1,2 @@
+export * from './list-button'
+export * from './use-list'

package/templates/tiptap/tiptap-ui/list-button/list-button.tsx

@@ -0,0 +1,108 @@
+'use client'
+
+import { forwardRef, useCallback } from 'react'
+// --- Hooks ---
+import { useTiptapEditor } from '../../hooks/use-tiptap-editor'
+// --- Lib ---
+import { parseShortcutKeys } from '../../lib/tiptap-utils'
+import { Badge } from '../../tiptap-ui-primitive/badge'
+// --- UI Primitives ---
+import type { ButtonProps } from '../../tiptap-ui-primitive/button'
+import { Button } from '../../tiptap-ui-primitive/button'
+
+// --- Tiptap UI ---
+import type { ListType, UseListConfig } from '.'
+import { LIST_SHORTCUT_KEYS, useList } from '.'
+
+export interface ListButtonProps extends Omit<ButtonProps, 'type'>, UseListConfig {
+  /**
+   * Optional text to display alongside the icon.
+   */
+  text?: string
+  /**
+   * Optional show shortcut keys in the button.
+   * @default false
+   */
+  showShortcut?: boolean
+}
+
+export function ListShortcutBadge({
+  type,
+  shortcutKeys = LIST_SHORTCUT_KEYS[type]
+}: {
+  type: ListType
+  shortcutKeys?: string
+}) {
+  return <Badge>{parseShortcutKeys({ shortcutKeys })}</Badge>
+}
+
+/**
+ * Button component for toggling lists in a Tiptap editor.
+ *
+ * For custom button implementations, use the `useList` hook instead.
+ */
+export const ListButton = forwardRef<HTMLButtonElement, ListButtonProps>(
+  (
+    {
+      editor: providedEditor,
+      type,
+      text,
+      hideWhenUnavailable = false,
+      onToggled,
+      showShortcut = false,
+      onClick,
+      children,
+      ...buttonProps
+    },
+    ref
+  ) => {
+    const { editor } = useTiptapEditor(providedEditor)
+    const { isVisible, canToggle, isActive, handleToggle, label, shortcutKeys, Icon } = useList({
+      editor,
+      type,
+      hideWhenUnavailable,
+      onToggled
+    })
+
+    const handleClick = useCallback(
+      (event: React.MouseEvent<HTMLButtonElement>) => {
+        onClick?.(event)
+        if (event.defaultPrevented) return
+        handleToggle()
+      },
+      [handleToggle, onClick]
+    )
+
+    if (!isVisible) {
+      return null
+    }
+
+    return (
+      <Button
+        type="button"
+        variant="ghost"
+        data-active-state={isActive ? 'on' : 'off'}
+        role="button"
+        tabIndex={-1}
+        disabled={!canToggle}
+        data-disabled={!canToggle}
+        aria-label={label}
+        aria-pressed={isActive}
+        tooltip={label}
+        onClick={handleClick}
+        {...buttonProps}
+        ref={ref}
+      >
+        {children ?? (
+          <>
+            <Icon className="tiptap-button-icon" />
+            {text && <span className="tiptap-button-text">{text}</span>}
+            {showShortcut && <ListShortcutBadge type={type} shortcutKeys={shortcutKeys} />}
+          </>
+        )}
+      </Button>
+    )
+  }
+)
+
+ListButton.displayName = 'ListButton'

package/templates/tiptap/tiptap-ui/list-button/use-list.ts

@@ -0,0 +1,329 @@
+'use client'
+
+import { NodeSelection, TextSelection } from '@tiptap/pm/state'
+import type { Editor } from '@tiptap/react'
+import { useCallback, useEffect, useState } from 'react'
+
+// --- Hooks ---
+import { useTiptapEditor } from '../../hooks/use-tiptap-editor'
+// --- Lib ---
+import {
+  findNodePosition,
+  getSelectedBlockNodes,
+  isNodeInSchema,
+  isNodeTypeSelected,
+  isValidPosition,
+  selectionWithinConvertibleTypes
+} from '../../lib/tiptap-utils'
+// --- Icons ---
+import { ListIcon } from '../../tiptap-icons/list-icon'
+import { ListOrderedIcon } from '../../tiptap-icons/list-ordered-icon'
+import { ListTodoIcon } from '../../tiptap-icons/list-todo-icon'
+
+export type ListType = 'bulletList' | 'orderedList' | 'taskList'
+
+/**
+ * Configuration for the list functionality
+ */
+export interface UseListConfig {
+  /**
+   * The Tiptap editor instance.
+   */
+  editor?: Editor | null
+  /**
+   * The type of list to toggle.
+   */
+  type: ListType
+  /**
+   * Whether the button should hide when list is not available.
+   * @default false
+   */
+  hideWhenUnavailable?: boolean
+  /**
+   * Callback function called after a successful toggle.
+   */
+  onToggled?: () => void
+}
+
+export const listIcons = {
+  bulletList: ListIcon,
+  orderedList: ListOrderedIcon,
+  taskList: ListTodoIcon
+}
+
+export const listLabels: Record<ListType, string> = {
+  bulletList: 'Bullet List',
+  orderedList: 'Ordered List',
+  taskList: 'Task List'
+}
+
+export const LIST_SHORTCUT_KEYS: Record<ListType, string> = {
+  bulletList: 'mod+shift+8',
+  orderedList: 'mod+shift+7',
+  taskList: 'mod+shift+9'
+}
+
+/**
+ * Checks if a list can be toggled in the current editor state
+ */
+export function canToggleList(
+  editor: Editor | null,
+  type: ListType,
+  turnInto: boolean = true
+): boolean {
+  if (!editor || !editor.isEditable) return false
+  if (!isNodeInSchema(type, editor) || isNodeTypeSelected(editor, ['image'])) return false
+
+  if (!turnInto) {
+    switch (type) {
+      case 'bulletList':
+        return editor.can().toggleBulletList()
+      case 'orderedList':
+        return editor.can().toggleOrderedList()
+      case 'taskList':
+        return editor.can().toggleList('taskList', 'taskItem')
+      default:
+        return false
+    }
+  }
+
+  // Ensure selection is in nodes we're allowed to convert
+  if (
+    !selectionWithinConvertibleTypes(editor, [
+      'paragraph',
+      'heading',
+      'bulletList',
+      'orderedList',
+      'taskList',
+      'blockquote',
+      'codeBlock'
+    ])
+  )
+    return false
+
+  // Either we can set list directly on the selection,
+  // or we can clear formatting/nodes to arrive at a list.
+  switch (type) {
+    case 'bulletList':
+      return editor.can().toggleBulletList() || editor.can().clearNodes()
+    case 'orderedList':
+      return editor.can().toggleOrderedList() || editor.can().clearNodes()
+    case 'taskList':
+      return editor.can().toggleList('taskList', 'taskItem') || editor.can().clearNodes()
+    default:
+      return false
+  }
+}
+
+/**
+ * Checks if list is currently active
+ */
+export function isListActive(editor: Editor | null, type: ListType): boolean {
+  if (!editor || !editor.isEditable) return false
+
+  switch (type) {
+    case 'bulletList':
+      return editor.isActive('bulletList')
+    case 'orderedList':
+      return editor.isActive('orderedList')
+    case 'taskList':
+      return editor.isActive('taskList')
+    default:
+      return false
+  }
+}
+
+/**
+ * Toggles list in the editor
+ */
+export function toggleList(editor: Editor | null, type: ListType): boolean {
+  if (!editor || !editor.isEditable) return false
+  if (!canToggleList(editor, type)) return false
+
+  try {
+    const view = editor.view
+    let state = view.state
+    let tr = state.tr
+
+    const blocks = getSelectedBlockNodes(editor)
+
+    // In case a selection contains multiple blocks, we only allow
+    // toggling to nide if there's exactly one block selected
+    // we also dont block the canToggle since it will fall back to the bottom logic
+    const isPossibleToTurnInto =
+      selectionWithinConvertibleTypes(editor, [
+        'paragraph',
+        'heading',
+        'bulletList',
+        'orderedList',
+        'taskList',
+        'blockquote',
+        'codeBlock'
+      ]) && blocks.length === 1
+
+    // No selection, find the the cursor position
+    if (
+      (state.selection.empty || state.selection instanceof TextSelection) &&
+      isPossibleToTurnInto
+    ) {
+      const pos = findNodePosition({
+        editor,
+        node: state.selection.$anchor.node(1)
+      })?.pos
+      if (!isValidPosition(pos)) return false
+
+      tr = tr.setSelection(NodeSelection.create(state.doc, pos))
+      view.dispatch(tr)
+      state = view.state
+    }
+
+    const selection = state.selection
+
+    let chain = editor.chain().focus()
+
+    // Handle NodeSelection
+    if (selection instanceof NodeSelection) {
+      const firstChild = selection.node.firstChild?.firstChild
+      const lastChild = selection.node.lastChild?.lastChild
+
+      const from = firstChild ? selection.from + firstChild.nodeSize : selection.from + 1
+
+      const to = lastChild ? selection.to - lastChild.nodeSize : selection.to - 1
+
+      const resolvedFrom = state.doc.resolve(from)
+      const resolvedTo = state.doc.resolve(to)
+
+      chain = chain.setTextSelection(TextSelection.between(resolvedFrom, resolvedTo)).clearNodes()
+    }
+
+    if (editor.isActive(type)) {
+      // Unwrap list
+      chain.liftListItem('listItem').lift('bulletList').lift('orderedList').lift('taskList').run()
+    } else {
+      // Wrap in specific list type
+      const toggleMap: Record<ListType, () => typeof chain> = {
+        bulletList: () => chain.toggleBulletList(),
+        orderedList: () => chain.toggleOrderedList(),
+        taskList: () => chain.toggleList('taskList', 'taskItem')
+      }
+
+      const toggle = toggleMap[type]
+      if (!toggle) return false
+
+      toggle().run()
+    }
+
+    editor.chain().focus().selectTextblockEnd().run()
+
+    return true
+  } catch {
+    return false
+  }
+}
+
+/**
+ * Determines if the list button should be shown
+ */
+export function shouldShowButton(props: {
+  editor: Editor | null
+  type: ListType
+  hideWhenUnavailable: boolean
+}): boolean {
+  const { editor, type, hideWhenUnavailable } = props
+
+  if (!editor || !editor.isEditable) return false
+
+  if (!hideWhenUnavailable) {
+    return true
+  }
+
+  if (!isNodeInSchema(type, editor)) return false
+
+  if (!editor.isActive('code')) {
+    return canToggleList(editor, type)
+  }
+
+  return true
+}
+
+/**
+ * Custom hook that provides list functionality for Tiptap editor
+ *
+ * @example
+ * ```tsx
+ * // Simple usage
+ * function MySimpleListButton() {
+ *   const { isVisible, handleToggle, isActive } = useList({ type: "bulletList" })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return <button onClick={handleToggle}>Bullet List</button>
+ * }
+ *
+ * // Advanced usage with configuration
+ * function MyAdvancedListButton() {
+ *   const { isVisible, handleToggle, label, isActive } = useList({
+ *     type: "orderedList",
+ *     editor: myEditor,
+ *     hideWhenUnavailable: true,
+ *     onToggled: () => console.log('List toggled!')
+ *   })
+ *
+ *   if (!isVisible) return null
+ *
+ *   return (
+ *     <MyButton
+ *       onClick={handleToggle}
+ *       aria-label={label}
+ *       aria-pressed={isActive}
+ *     >
+ *       Toggle List
+ *     </MyButton>
+ *   )
+ * }
+ * ```
+ */
+export function useList(config: UseListConfig) {
+  const { editor: providedEditor, type, hideWhenUnavailable = false, onToggled } = config
+
+  const { editor } = useTiptapEditor(providedEditor)
+  const [isVisible, setIsVisible] = useState<boolean>(true)
+  const canToggle = canToggleList(editor, type)
+  const isActive = isListActive(editor, type)
+
+  useEffect(() => {
+    if (!editor) return
+
+    const handleSelectionUpdate = () => {
+      setIsVisible(shouldShowButton({ editor, type, hideWhenUnavailable }))
+    }
+
+    handleSelectionUpdate()
+
+    editor.on('selectionUpdate', handleSelectionUpdate)
+
+    return () => {
+      editor.off('selectionUpdate', handleSelectionUpdate)
+    }
+  }, [editor, type, hideWhenUnavailable])
+
+  const handleToggle = useCallback(() => {
+    if (!editor) return false
+
+    const success = toggleList(editor, type)
+    if (success) {
+      onToggled?.()
+    }
+    return success
+  }, [editor, type, onToggled])
+
+  return {
+    isVisible,
+    isActive,
+    handleToggle,
+    canToggle,
+    label: listLabels[type],
+    shortcutKeys: LIST_SHORTCUT_KEYS[type],
+    Icon: listIcons[type]
+  }
+}