Improvements on the documentation of useEditorIsActive

[kkdaisuki]

It appears that in the current implementation, when only one parameter is provided, it would be always interpreted as options.

// This would always return true
useEditorIsActive(editor, 'heading')
// This would work as intended
useEditorIsActive(editor, 'heading', {})

This is different from the official Editor API in the Tiptap documentation where the only parameter may be interpreted either way as options or as the name of the node or mark, i.e.,

// Check if it’s a heading
editor.isActive('heading')
// Check if it’s a heading with a specific attribute value
editor.isActive('heading', { level: 2 })
// Check if it has a specific attribute value, doesn’t care what node/mark it is
editor.isActive({ textAlign: 'justify' })

This behavior is certainly related to

solid-tiptap/packages/solid-tiptap/src/Editor.tsx

Line 84 in 6b7f27a

return instance?.isActive(args[0]);

where the case of only one parameter is defaulted as the options, thus not evaluated.

To make things clearer, this discrepancy would better be either documented or fixed like

// Not tested
export function useEditorIsActive<
  V extends Editor | undefined,
  R extends Record<string, any>,
>(
  editor: () => V,
  ...args: [name: () => string, options?: R] | [options: R] | [name: () => string]
): () => boolean | undefined {
  return createEditorTransaction(editor, instance => {
    if (args.length === 2) {
      return instance?.isActive(args[0](), args[1]);
    }
    return (typeof args[0] === "function") ? instance?.isActive(args[0]()) : instance?.isActive(args[0]);
  });
}