@sit-onyx/tiptap 0.3.0-dev-20260602090424 → 0.3.0-dev-20260602112836
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/component-meta.json +1 -1
- package/package.json +7 -7
package/dist/component-meta.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
[{"exportName":"default","displayName":"OnyxEditorToolbarFlyout","type":1,"props":[{"name":"label","global":false,"description":"Label for the flyout button.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"icon","global":false,"description":"Icon for the flyout button.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"options","global":false,"description":"List of available options.","tags":[],"required":true,"type":"EditorToolbarFlyoutOption[]","schema":"EditorToolbarFlyoutOption[]","declarations":[]}],"events":[],"slots":[],"exposed":[]},{"exportName":"default","displayName":"OnyxEditorToolbarGroup","type":1,"props":[],"events":[],"slots":[{"name":"default","type":"any","description":"Toolbar actions related to this group.","tags":[],"schema":"any","declarations":[]}],"exposed":[]},{"exportName":"default","displayName":"OnyxEditorToolbarAction","type":1,"props":[{"name":"label","global":false,"description":"Button label / text to show. Is always required (even if `icon` is set) for screen readers / accessibility.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"disabled","global":false,"description":"If the button should be disabled or not.","tags":[],"required":false,"type":"FormInjected<boolean> | undefined","schema":{"kind":"enum","type":"FormInjected<boolean> | undefined","schema":["undefined","false","true","symbol"]},"declarations":[]},{"name":"icon","global":false,"description":"Icon to show. Will visually hide the label if set.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"active","global":false,"description":"Whether the action is currently active.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]}],"events":[],"slots":[{"name":"default","type":"any","description":"Optional slot to override the button content.","tags":[],"schema":"any","declarations":[]}],"exposed":[]},{"exportName":"default","displayName":"OnyxTextEditor","type":1,"props":[{"name":"label","global":false,"description":"Label to show for the element. Required due to accessibility / screen readers.\nIf you want to visually hide the label, use the `label.hidden` property.","tags":[],"required":true,"type":"string | FormElementV2LabelOptions","schema":{"kind":"enum","type":"string | FormElementV2LabelOptions","schema":["string",{"kind":"object","type":"FormElementV2LabelOptions","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]},"position":{"name":"position","global":false,"description":"How to position the label relative to the main content.","tags":[],"required":false,"type":"\"top\" | \"left\" | \"right\" | undefined","schema":{"kind":"enum","type":"\"top\" | \"left\" | \"right\" | undefined","schema":["undefined","\"top\"","\"left\"","\"right\""]},"declarations":[]},"hidden":{"name":"hidden","global":false,"description":"If `true`, the label will be visually hidden.\nFor accessibility / screen readers, the aria-label will still be set.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]}}}]},"declarations":[]},{"name":"requiredMarker","global":false,"default":"FORM_INJECTED_SYMBOL","description":"How to display the required / optional marker.\n- optional: will show an `(optional)` text after the label for optional form elements.\n- required: will show an `*` indicator for required inputs after the label instead.\n\nNo marker will be visible if the label is hidden.","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component or `required` if none exists"}],"required":false,"type":"FormInjected<\"required\" | \"optional\"> | undefined","schema":{"kind":"enum","type":"FormInjected<\"required\" | \"optional\"> | undefined","schema":["undefined","symbol","\"required\"","\"optional\""]},"declarations":[]},{"name":"reserveMessageSpace","global":false,"default":"FORM_INJECTED_SYMBOL","description":"Always reserves the space required to show `error` or other messages.\nSubsequently this will increase the height of the form element permanently.\nWe recommend to enable this to avoid layout shifts.","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component, defaults to `false` otherwise"}],"required":false,"type":"FormInjected<boolean> | undefined","schema":{"kind":"enum","type":"FormInjected<boolean> | undefined","schema":["undefined","false","true","symbol"]},"declarations":[]},{"name":"showError","global":false,"default":"FORM_INJECTED_SYMBOL","description":"Configures if and when errors are shown.\n- `true`: errors will be shown initially.\n- `false`: errors will never be shown. ⚠️ Only the displaying of the error is effected! An error can still block submission!\n- \"touched\": only shows an error *after* a user has significantly interacted with the input, see [\\:user-invalid](https://drafts.csswg.org/selectors/#user-invalid-pseudo)","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component or `touched` if none exists"}],"required":false,"type":"FormInjected<ShowErrorMode> | undefined","schema":{"kind":"enum","type":"FormInjected<ShowErrorMode> | undefined","schema":["undefined","false","true","symbol","\"touched\""]},"declarations":[]},{"name":"density","global":false,"description":"Density defines the amount of vertical white space a component has and the height of the main (interactive) element of a component.","tags":[{"name":"default","text":"undefined By default the parents setting is used, if none is defined on any parent `default` is the default."}],"required":false,"type":"\"default\" | \"compact\" | \"cozy\" | undefined","schema":{"kind":"enum","type":"\"default\" | \"compact\" | \"cozy\" | undefined","schema":["undefined","\"default\"","\"compact\"","\"cozy\""]},"declarations":[]},{"name":"skeleton","global":false,"default":"SKELETON_INJECTED_SYMBOL","description":"Whether to show as skeleton.","tags":[],"required":false,"type":"SkeletonInjected | undefined","schema":{"kind":"enum","type":"SkeletonInjected | undefined","schema":["undefined","number","false","true","symbol"]},"declarations":[]},{"name":"message","global":false,"description":"Optional message to show below the form element.","tags":[],"required":false,"type":"string | FormElementV2Tooltip | undefined","schema":{"kind":"enum","type":"string | FormElementV2Tooltip | undefined","schema":["undefined","string",{"kind":"object","type":"FormElementV2Tooltip","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]}}}]},"declarations":[]},{"name":"error","global":false,"description":"Optional error message to show below the form element.","tags":[],"required":false,"type":"string | FormElementV2Tooltip | undefined","schema":{"kind":"enum","type":"string | FormElementV2Tooltip | undefined","schema":["undefined","string",{"kind":"object","type":"FormElementV2Tooltip","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]}}}]},"declarations":[]},{"name":"success","global":false,"description":"Optional success message to show below the form element.","tags":[],"required":false,"type":"string | FormElementV2Tooltip | undefined","schema":{"kind":"enum","type":"string | FormElementV2Tooltip | undefined","schema":["undefined","string",{"kind":"object","type":"FormElementV2Tooltip","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]}}}]},"declarations":[]},{"name":"required","global":false,"description":"Whether the a value for this form element is required.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"loading","global":false,"description":"Whether a loading indicator should be shown.\nWill hide the `leadingIcons` slot if set.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"disabled","global":false,"default":"FORM_INJECTED_SYMBOL","description":"Whether the input should be disabled and prevent the user from interacting with it.\nDisabled makes the element not mutable, focusable, or even submitted with the form.\nIt will also not be validated.","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component, defaults to `false` otherwise"}],"required":false,"type":"FormInjected<boolean> | undefined","schema":{"kind":"enum","type":"FormInjected<boolean> | undefined","schema":["undefined","false","true","symbol"]},"declarations":[]},{"name":"autofocus","global":false,"description":"Whether to focus the component on page load or inside a dialog/popover once it opens.\nCan only be enabled for one element inside a page/dialog/popover.\nNote: Has no effect when set after the component has been mounted.\n\n**UX / Accessibility**: autofocus should be used carefully since it can reduce usability and accessibility for users.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"placeholder","global":false,"description":"Placeholder to show when the value is empty.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]},{"name":"withCounter","global":false,"description":"If `true`, a character counter will be displayed if `maxLength` is set.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"disableManualResize","global":false,"description":"If `true`, the user will not be able to manually resize the textarea by dragging the bottom right corner.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"autosize","global":false,"description":"Override the default autosize behavior (height adjusts based on the current value).\nBy default, the textarea will autosize while maintaining at least 3 and at most 10 rows.\nIf the user resizes the textarea manually, the autosize will no longer work and the height\nset by the user is used.","tags":[],"required":false,"type":"TextareaAutosize | undefined","schema":{"kind":"enum","type":"TextareaAutosize | undefined","schema":["undefined",{"kind":"object","type":"TextareaAutosize","schema":{"min":{"name":"min","global":false,"description":"Sets the min height to the given number of rows/lines.\nMust be `>= 2`. Will also be considered if the user resizes manually.","tags":[],"required":false,"type":"number | undefined","schema":{"kind":"enum","type":"number | undefined","schema":["undefined","number"]},"declarations":[]},"max":{"name":"max","global":false,"description":"Sets the max height to the given number of rows/lines.\nIf omitted, the textarea can grow unlimited.\nWill be ignored if the user resizes manually.","tags":[],"required":false,"type":"number | undefined","schema":"number | undefined","declarations":[]}}}]},"declarations":[]},{"name":"modelValue","global":false,"description":"Current editor value.","tags":[],"required":false,"type":"Nullable<string>","schema":{"kind":"enum","type":"Nullable<string>","schema":["undefined","null","string"]},"declarations":[]},{"name":"toolbar","global":false,"default":"{ position: \"top\" }","description":"Toolbar config.","tags":[],"required":false,"type":"ToolbarOptions | undefined","schema":{"kind":"enum","type":"ToolbarOptions | undefined","schema":["undefined",{"kind":"object","type":"ToolbarOptions","schema":{"position":{"name":"position","global":false,"description":"How to position the toolbar.","tags":[{"name":"default","text":"\"top\""}],"required":false,"type":"\"top\" | \"bottom\" | undefined","schema":{"kind":"enum","type":"\"top\" | \"bottom\" | undefined","schema":["undefined","\"top\"","\"bottom\""]},"declarations":[]}}}]},"declarations":[]},{"name":"extensions","global":false,"default":"[OnyxStarterKit]","description":"Tiptap extensions to use. Should not be changed dynamically.\nIf set, default extensions will be overridden. Use or configure the OnyxStarterKit in this case.","tags":[],"required":false,"type":"Extensions | undefined","schema":{"kind":"enum","type":"Extensions | undefined","schema":["undefined","Extensions"]},"declarations":[]},{"name":"minlength","global":false,"description":"Minimum number of characters that have to to be entered.\nCharacter count is determined using Tiptap's [CharacterCount extension](https://tiptap.dev/docs/editor/extensions/functionality/character-count).","tags":[],"required":false,"type":"number | undefined","schema":{"kind":"enum","type":"number | undefined","schema":["undefined","number"]},"declarations":[]},{"name":"maxlength","global":false,"description":"Maximum number of characters that are allowed to be entered.\nCharacter count is determined using Tiptap's [CharacterCount extension](https://tiptap.dev/docs/editor/extensions/functionality/character-count).","tags":[],"required":false,"type":"number | undefined","schema":{"kind":"enum","type":"number | undefined","schema":["undefined","number"]},"declarations":[]}],"events":[{"name":"update:modelValue","description":"Emitted when the value of the editor changes.","tags":[],"type":"[value: string]","signature":"(event: \"update:modelValue\", value: string): void","schema":["string"],"declarations":[]}],"slots":[{"name":"actions","type":"any","description":"Optional slot to add custom actions to the toolbar.","tags":[],"schema":"any","declarations":[]}],"exposed":[{"name":"editor","type":"Editor | undefined","description":"Tiptap editor instance.","tags":[],"schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}]},{"exportName":"default","displayName":"EditorToolbar","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[{"name":"default","type":"any","description":"Optional slot to add custom actions to the toolbar.","tags":[],"schema":"any","declarations":[]}],"exposed":[]},{"exportName":"default","displayName":"ListToolbarAction","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[],"exposed":[]},{"exportName":"default","displayName":"LinkToolbarAction","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[],"exposed":[]},{"exportName":"default","displayName":"HeadingToolbarAction","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[],"exposed":[]}]
|
|
1
|
+
[{"exportName":"default","displayName":"OnyxEditorToolbarAction","type":1,"props":[{"name":"label","global":false,"description":"Button label / text to show. Is always required (even if `icon` is set) for screen readers / accessibility.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"disabled","global":false,"description":"If the button should be disabled or not.","tags":[],"required":false,"type":"FormInjected<boolean> | undefined","schema":{"kind":"enum","type":"FormInjected<boolean> | undefined","schema":["undefined","false","true","symbol"]},"declarations":[]},{"name":"icon","global":false,"description":"Icon to show. Will visually hide the label if set.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"active","global":false,"description":"Whether the action is currently active.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]}],"events":[],"slots":[{"name":"default","type":"any","description":"Optional slot to override the button content.","tags":[],"schema":"any","declarations":[]}],"exposed":[]},{"exportName":"default","displayName":"OnyxEditorToolbarFlyout","type":1,"props":[{"name":"label","global":false,"description":"Label for the flyout button.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"icon","global":false,"description":"Icon for the flyout button.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},{"name":"options","global":false,"description":"List of available options.","tags":[],"required":true,"type":"EditorToolbarFlyoutOption[]","schema":"EditorToolbarFlyoutOption[]","declarations":[]}],"events":[],"slots":[],"exposed":[]},{"exportName":"default","displayName":"OnyxEditorToolbarGroup","type":1,"props":[],"events":[],"slots":[{"name":"default","type":"any","description":"Toolbar actions related to this group.","tags":[],"schema":"any","declarations":[]}],"exposed":[]},{"exportName":"default","displayName":"OnyxTextEditor","type":1,"props":[{"name":"requiredMarker","global":false,"default":"FORM_INJECTED_SYMBOL","description":"How to display the required / optional marker.\n- optional: will show an `(optional)` text after the label for optional form elements.\n- required: will show an `*` indicator for required inputs after the label instead.\n\nNo marker will be visible if the label is hidden.","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component or `required` if none exists"}],"required":false,"type":"FormInjected<\"required\" | \"optional\"> | undefined","schema":{"kind":"enum","type":"FormInjected<\"required\" | \"optional\"> | undefined","schema":["undefined","symbol","\"required\"","\"optional\""]},"declarations":[]},{"name":"reserveMessageSpace","global":false,"default":"FORM_INJECTED_SYMBOL","description":"Always reserves the space required to show `error` or other messages.\nSubsequently this will increase the height of the form element permanently.\nWe recommend to enable this to avoid layout shifts.","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component, defaults to `false` otherwise"}],"required":false,"type":"FormInjected<boolean> | undefined","schema":{"kind":"enum","type":"FormInjected<boolean> | undefined","schema":["undefined","false","true","symbol"]},"declarations":[]},{"name":"showError","global":false,"default":"FORM_INJECTED_SYMBOL","description":"Configures if and when errors are shown.\n- `true`: errors will be shown initially.\n- `false`: errors will never be shown. ⚠️ Only the displaying of the error is effected! An error can still block submission!\n- \"touched\": only shows an error *after* a user has significantly interacted with the input, see [\\:user-invalid](https://drafts.csswg.org/selectors/#user-invalid-pseudo)","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component or `touched` if none exists"}],"required":false,"type":"FormInjected<ShowErrorMode> | undefined","schema":{"kind":"enum","type":"FormInjected<ShowErrorMode> | undefined","schema":["undefined","false","true","symbol","\"touched\""]},"declarations":[]},{"name":"density","global":false,"description":"Density defines the amount of vertical white space a component has and the height of the main (interactive) element of a component.","tags":[{"name":"default","text":"undefined By default the parents setting is used, if none is defined on any parent `default` is the default."}],"required":false,"type":"\"default\" | \"compact\" | \"cozy\" | undefined","schema":{"kind":"enum","type":"\"default\" | \"compact\" | \"cozy\" | undefined","schema":["undefined","\"default\"","\"compact\"","\"cozy\""]},"declarations":[]},{"name":"label","global":false,"description":"Label to show for the element. Required due to accessibility / screen readers.\nIf you want to visually hide the label, use the `label.hidden` property.","tags":[],"required":true,"type":"string | FormElementV2LabelOptions","schema":{"kind":"enum","type":"string | FormElementV2LabelOptions","schema":["string",{"kind":"object","type":"FormElementV2LabelOptions","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]},"position":{"name":"position","global":false,"description":"How to position the label relative to the main content.","tags":[],"required":false,"type":"\"top\" | \"left\" | \"right\" | undefined","schema":{"kind":"enum","type":"\"top\" | \"left\" | \"right\" | undefined","schema":["undefined","\"top\"","\"left\"","\"right\""]},"declarations":[]},"hidden":{"name":"hidden","global":false,"description":"If `true`, the label will be visually hidden.\nFor accessibility / screen readers, the aria-label will still be set.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]}}}]},"declarations":[]},{"name":"skeleton","global":false,"default":"SKELETON_INJECTED_SYMBOL","description":"Whether to show as skeleton.","tags":[],"required":false,"type":"SkeletonInjected | undefined","schema":{"kind":"enum","type":"SkeletonInjected | undefined","schema":["undefined","number","false","true","symbol"]},"declarations":[]},{"name":"message","global":false,"description":"Optional message to show below the form element.","tags":[],"required":false,"type":"string | FormElementV2Tooltip | undefined","schema":{"kind":"enum","type":"string | FormElementV2Tooltip | undefined","schema":["undefined","string",{"kind":"object","type":"FormElementV2Tooltip","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]}}}]},"declarations":[]},{"name":"error","global":false,"description":"Optional error message to show below the form element.","tags":[],"required":false,"type":"string | FormElementV2Tooltip | undefined","schema":{"kind":"enum","type":"string | FormElementV2Tooltip | undefined","schema":["undefined","string",{"kind":"object","type":"FormElementV2Tooltip","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]}}}]},"declarations":[]},{"name":"success","global":false,"description":"Optional success message to show below the form element.","tags":[],"required":false,"type":"string | FormElementV2Tooltip | undefined","schema":{"kind":"enum","type":"string | FormElementV2Tooltip | undefined","schema":["undefined","string",{"kind":"object","type":"FormElementV2Tooltip","schema":{"label":{"name":"label","global":false,"description":"Label displayed outside of the tooltip.","tags":[],"required":true,"type":"string","schema":"string","declarations":[]},"tooltipText":{"name":"tooltipText","global":false,"description":"Actual tooltip text.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]}}}]},"declarations":[]},{"name":"required","global":false,"description":"Whether the a value for this form element is required.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"loading","global":false,"description":"Whether a loading indicator should be shown.\nWill hide the `leadingIcons` slot if set.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"disabled","global":false,"default":"FORM_INJECTED_SYMBOL","description":"Whether the input should be disabled and prevent the user from interacting with it.\nDisabled makes the element not mutable, focusable, or even submitted with the form.\nIt will also not be validated.","tags":[{"name":"default","text":"Inherits value from closest `<OnyxForm>` component, defaults to `false` otherwise"}],"required":false,"type":"FormInjected<boolean> | undefined","schema":{"kind":"enum","type":"FormInjected<boolean> | undefined","schema":["undefined","false","true","symbol"]},"declarations":[]},{"name":"autofocus","global":false,"description":"Whether to focus the component on page load or inside a dialog/popover once it opens.\nCan only be enabled for one element inside a page/dialog/popover.\nNote: Has no effect when set after the component has been mounted.\n\n**UX / Accessibility**: autofocus should be used carefully since it can reduce usability and accessibility for users.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"placeholder","global":false,"description":"Placeholder to show when the value is empty.","tags":[],"required":false,"type":"string | undefined","schema":{"kind":"enum","type":"string | undefined","schema":["undefined","string"]},"declarations":[]},{"name":"withCounter","global":false,"description":"If `true`, a character counter will be displayed if `maxLength` is set.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"disableManualResize","global":false,"description":"If `true`, the user will not be able to manually resize the textarea by dragging the bottom right corner.","tags":[],"required":false,"type":"boolean | undefined","schema":{"kind":"enum","type":"boolean | undefined","schema":["undefined","false","true"]},"declarations":[]},{"name":"autosize","global":false,"description":"Override the default autosize behavior (height adjusts based on the current value).\nBy default, the textarea will autosize while maintaining at least 3 and at most 10 rows.\nIf the user resizes the textarea manually, the autosize will no longer work and the height\nset by the user is used.","tags":[],"required":false,"type":"TextareaAutosize | undefined","schema":{"kind":"enum","type":"TextareaAutosize | undefined","schema":["undefined",{"kind":"object","type":"TextareaAutosize","schema":{"min":{"name":"min","global":false,"description":"Sets the min height to the given number of rows/lines.\nMust be `>= 2`. Will also be considered if the user resizes manually.","tags":[],"required":false,"type":"number | undefined","schema":{"kind":"enum","type":"number | undefined","schema":["undefined","number"]},"declarations":[]},"max":{"name":"max","global":false,"description":"Sets the max height to the given number of rows/lines.\nIf omitted, the textarea can grow unlimited.\nWill be ignored if the user resizes manually.","tags":[],"required":false,"type":"number | undefined","schema":"number | undefined","declarations":[]}}}]},"declarations":[]},{"name":"modelValue","global":false,"description":"Current editor value.","tags":[],"required":false,"type":"Nullable<string>","schema":{"kind":"enum","type":"Nullable<string>","schema":["undefined","null","string"]},"declarations":[]},{"name":"toolbar","global":false,"default":"{ position: \"top\" }","description":"Toolbar config.","tags":[],"required":false,"type":"ToolbarOptions | undefined","schema":{"kind":"enum","type":"ToolbarOptions | undefined","schema":["undefined",{"kind":"object","type":"ToolbarOptions","schema":{"position":{"name":"position","global":false,"description":"How to position the toolbar.","tags":[{"name":"default","text":"\"top\""}],"required":false,"type":"\"top\" | \"bottom\" | undefined","schema":{"kind":"enum","type":"\"top\" | \"bottom\" | undefined","schema":["undefined","\"top\"","\"bottom\""]},"declarations":[]}}}]},"declarations":[]},{"name":"extensions","global":false,"default":"[OnyxStarterKit]","description":"Tiptap extensions to use. Should not be changed dynamically.\nIf set, default extensions will be overridden. Use or configure the OnyxStarterKit in this case.","tags":[],"required":false,"type":"Extensions | undefined","schema":{"kind":"enum","type":"Extensions | undefined","schema":["undefined","Extensions"]},"declarations":[]},{"name":"minlength","global":false,"description":"Minimum number of characters that have to to be entered.\nCharacter count is determined using Tiptap's [CharacterCount extension](https://tiptap.dev/docs/editor/extensions/functionality/character-count).","tags":[],"required":false,"type":"number | undefined","schema":{"kind":"enum","type":"number | undefined","schema":["undefined","number"]},"declarations":[]},{"name":"maxlength","global":false,"description":"Maximum number of characters that are allowed to be entered.\nCharacter count is determined using Tiptap's [CharacterCount extension](https://tiptap.dev/docs/editor/extensions/functionality/character-count).","tags":[],"required":false,"type":"number | undefined","schema":{"kind":"enum","type":"number | undefined","schema":["undefined","number"]},"declarations":[]}],"events":[{"name":"update:modelValue","description":"Emitted when the value of the editor changes.","tags":[],"type":"[value: string]","signature":"(event: \"update:modelValue\", value: string): void","schema":["string"],"declarations":[]}],"slots":[{"name":"actions","type":"any","description":"Optional slot to add custom actions to the toolbar.","tags":[],"schema":"any","declarations":[]}],"exposed":[{"name":"editor","type":"Editor | undefined","description":"Tiptap editor instance.","tags":[],"schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}]},{"exportName":"default","displayName":"EditorToolbar","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[{"name":"default","type":"any","description":"Optional slot to add custom actions to the toolbar.","tags":[],"schema":"any","declarations":[]}],"exposed":[]},{"exportName":"default","displayName":"HeadingToolbarAction","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[],"exposed":[]},{"exportName":"default","displayName":"LinkToolbarAction","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[],"exposed":[]},{"exportName":"default","displayName":"ListToolbarAction","type":1,"props":[{"name":"editor","global":false,"description":"","tags":[],"required":false,"type":"Editor | undefined","schema":{"kind":"enum","type":"Editor | undefined","schema":["undefined","Editor"]},"declarations":[]}],"events":[],"slots":[],"exposed":[]}]
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sit-onyx/tiptap",
|
|
3
3
|
"description": "A rich text editor powered by the Tiptap editor and the onyx design system created by Schwarz IT",
|
|
4
|
-
"version": "0.3.0-dev-
|
|
4
|
+
"version": "0.3.0-dev-20260602112836",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": "Schwarz IT KG",
|
|
7
7
|
"license": "Apache-2.0",
|
|
@@ -38,8 +38,8 @@
|
|
|
38
38
|
"@tiptap/starter-kit": ">= 3",
|
|
39
39
|
"@tiptap/vue-3": ">= 3",
|
|
40
40
|
"vue": ">= 3.5.0",
|
|
41
|
-
"sit-onyx": "^1.
|
|
42
|
-
"
|
|
41
|
+
"@sit-onyx/icons": "^1.10.0-dev-20260602112836",
|
|
42
|
+
"sit-onyx": "^1.14.0-dev-20260602112836"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"@axe-core/playwright": "^4.11.3",
|
|
@@ -54,12 +54,12 @@
|
|
|
54
54
|
"@vue/compiler-dom": "3.5.35",
|
|
55
55
|
"unplugin-dts": "1.0.1",
|
|
56
56
|
"vite": "8.0.14",
|
|
57
|
-
"@sit-onyx/icons": "^1.10.0-dev-
|
|
58
|
-
"@sit-onyx/storybook-utils": "^1.1.3",
|
|
59
|
-
"@sit-onyx/vite-plugin-component-meta": "^0.0.0",
|
|
57
|
+
"@sit-onyx/icons": "^1.10.0-dev-20260602112836",
|
|
60
58
|
"@sit-onyx/playwright-utils": "^1.3.0",
|
|
61
59
|
"@sit-onyx/shared": "^0.1.0",
|
|
62
|
-
"sit-onyx": "^1.
|
|
60
|
+
"@sit-onyx/storybook-utils": "^1.1.3",
|
|
61
|
+
"@sit-onyx/vite-plugin-component-meta": "^0.0.0",
|
|
62
|
+
"sit-onyx": "^1.14.0-dev-20260602112836"
|
|
63
63
|
},
|
|
64
64
|
"scripts": {
|
|
65
65
|
"dev": "storybook dev -p 6006 --no-open",
|