{"pageProps":{"error":null,"preview":false,"file":{"fileRelativePath":"content/docs/ui/inline-editing/inline-wysiwyg.md","data":{"frontmatter":{"title":"Inline Wysiwyg","prev":"/docs/ui/inline-editing/inline-textarea","next":"/docs/ui/inline-editing/inline-image","consumes":[{"file":"/packages/react-tinacms-inline/src/inline-wysiwyg.tsx","description":"Shows InlineWysiwyg"},{"file":"/packages/react-tinacms-inline/src/inline-field.tsx","description":"Depends on InlineField"},{"file":"/packages/react-tinacms-editor/src/Wysiwyg.tsx","description":"Depends on the Wysiwyg interface"},{"file":"/packages/react-tinacms-editor/src/Translator/index.ts","description":"Depends on the `Format` type"},{"file":"/packages/react-tinacms-editor/src/types.ts","description":"Depends on `ImageProps`"}]},"excerpt":" The InlineWysiwyg field represents a chunk of Markdown or HTML content. Install react-tinacms-editor The InlineWysiwyg field is not a default field within react-tinacms-inline. In order to use it in&hellip;","markdownBody":"\nThe `InlineWysiwyg` field represents a chunk of Markdown or HTML content.\n\n## Install _react-tinacms-editor_\n\nThe `InlineWysiwyg` field is not a default field within `react-tinacms-inline`. In order to use it in your site you must install the `react-tinacms-editor` package:\n\n```bash\nyarn add react-tinacms-editor\n```\n\n## Definition\n\nBelow is an example of how an `InlineWysiwyg` field could be defined in an [Inline Form](/docs/ui/inline-editing).\n\n```jsx\nimport ReactMarkdown from 'react-markdown'\nimport { useForm, usePlugin } from 'tinacms'\nimport { InlineForm } from 'react-tinacms-inline'\nimport { InlineWysiwyg } from 'react-tinacms-editor'\n\n// Example 'Page' Component\nexport function Page(props) {\n  const [data, form] = useForm(props.data)\n  usePlugin(form)\n  return (\n    <InlineForm form={form}>\n      <InlineWysiwyg name=\"markdownBody\" format=\"markdown\">\n        <ReactMarkdown source={data.markdownBody} />\n      </InlineWysiwyg>\n    </InlineForm>\n  )\n}\n```\n\n## Options\n\n| Key           | Description                                                                                  |\n| ------------- | -------------------------------------------------------------------------------------------- |\n| `name`        | The path to some value in the data being edited.                                             |\n| `children`    | Child components to render.                                                                  |\n| `sticky?`     | A boolean determining whether the Wysiwyg Toolbar 'sticks' to the top of the page on scroll. |\n| `format?`     | This value denotes whether Markdown or HTML will be rendered.                                |\n| `imageProps?` | Configures how images in the Wysiwyg are uploaded and rendered.                              |\n\n## Interface\n\n```typescript\ninterface InlineWysiwygConfig {\n  name: string\n  children: any\n  sticky?: boolean\n  format?: 'markdown' | 'html'\n  imageProps?: WysiwysImageProps\n}\n\ninterface WysiwygImageProps {\n  upload?: (files: File[]) => Promise<string[]>\n  previewUrl?: (url: string) => string\n}\n```\n\n<!-- TODO: Add better explanation (or example) of how to work with the Image Props -->\n"}},"tocItems":"- [Install _react-tinacms-editor_](#install-react-tinacms-editor)\n- [Definition](#definition)\n- [Options](#options)\n- [Interface](#interface)","docsNav":[{"title":"Getting Started","id":"getting-started","items":[{"id":"/docs/getting-started/introduction","slug":"/docs/getting-started/introduction","title":"Introduction"}]},{"title":"CMS","id":"the-cms","items":[{"id":"/docs/cms","slug":"/docs/cms","title":"Overview"}]},{"title":"User Interface","id":"user-interface","items":[{"id":"/docs/ui","title":"Sidebar & Toolbar","slug":"/docs/ui"},{"title":"Inline Editing","id":"inline-editing","slug":"/docs/ui/inline-editing","items":[{"id":"/docs/ui/inline-editing/inline-text","title":"Inline Text","slug":"/docs/ui/inline-editing/inline-text"},{"id":"/docs/ui/inline-editing/inline-textarea","title":"Inline Textarea","slug":"/docs/ui/inline-editing/inline-textarea"},{"id":"/docs/ui/inline-editing/inline-wysiwyg","title":"Inline Wysiwyg","slug":"/docs/ui/inline-editing/inline-wysiwyg"},{"id":"/docs/ui/inline-editing/inline-image","title":"Inline Image","slug":"/docs/ui/inline-editing/inline-image"},{"id":"/docs/ui/inline-editing/inline-group","title":"Inline Group","slug":"/docs/ui/inline-editing/inline-group"},{"id":"/docs/ui/inline-editing/inline-blocks","title":"Inline Blocks","slug":"/docs/ui/inline-editing/inline-blocks"}]},{"id":"/docs/ui/alerts","title":"Alerts","slug":"/docs/ui/alerts"},{"id":"/docs/ui/styles","title":"Custom Styles","slug":"/docs/ui/styles"}]},{"id":"plugins","title":"Plugins","items":[{"title":"About Plugins","id":"forms","slug":"/docs/plugins"},{"title":"Forms","id":"forms","slug":"/docs/plugins/forms"},{"title":"Fields","id":"fields","slug":"/docs/plugins/fields","items":[{"id":"/docs/plugins/fields/text","slug":"/docs/plugins/fields/text","title":"Text"},{"id":"/docs/plugins/fields/textarea","slug":"/docs/plugins/fields/textarea","title":"Text Area"},{"id":"/docs/plugins/fields/number","slug":"/docs/plugins/fields/number","title":"Number"},{"id":"/docs/plugins/fields/image","slug":"/docs/plugins/fields/image","title":"Image"},{"id":"/docs/plugins/fields/color","slug":"/docs/plugins/fields/color","title":"Color"},{"id":"/docs/plugins/fields/toggle","slug":"/docs/plugins/fields/toggle","title":"Toggle"},{"id":"/docs/plugins/fields/select","slug":"/docs/plugins/fields/select","title":"Select"},{"id":"/docs/plugins/fields/tags","slug":"/docs/plugins/fields/tags","title":"Tags"},{"id":"/docs/plugins/fields/list","slug":"/docs/plugins/fields/list","title":"List"},{"id":"/docs/plugins/fields/group","slug":"/docs/plugins/fields/group","title":"Group"},{"id":"/docs/plugins/fields/group-list","slug":"/docs/plugins/fields/group-list","title":"Group List"},{"id":"/docs/plugins/fields/blocks","slug":"/docs/plugins/fields/blocks","title":"Blocks"},{"id":"/docs/plugins/fields/date","slug":"/docs/plugins/fields/date","title":"Date & Time"},{"id":"/docs/plugins/fields/markdown","slug":"/docs/plugins/fields/markdown","title":"Markdown"},{"id":"/docs/plugins/fields/html","slug":"/docs/plugins/fields/html","title":"HTML"},{"id":"/docs/plugins/fields/custom-fields","slug":"/docs/plugins/fields/custom-fields","title":"Custom Fields"}]},{"title":"Content Creators","id":"content-creator","slug":"/docs/plugins/content-creators"},{"title":"Screens","id":"screens","slug":"/docs/plugins/screens"},{"title":"Toolbar Widgets","id":"toolbar:widget","slug":"/docs/plugins/toolbar-widgets"}]},{"id":"events","title":"Events","items":[{"id":"/docs/events","slug":"/docs/events","title":"About Events"}]},{"title":"Media","id":"media","items":[{"id":"/docs/media","slug":"/docs/media","title":"About Media"}]},{"id":"apis","title":"External APIs","items":[{"id":"/docs/api","slug":"/docs/apis","title":"About APIs"}]},{"title":"Integrations","id":"nextjs","items":[{"id":"/docs/integrations/nextjs","slug":"/docs/integrations/nextjs","title":"Next.js"},{"id":"/docs/integrations/gatsby","slug":"/docs/integrations/gatsby","title":"Gatsby"}]},{"title":"Release Notes","id":"releases","items":[{"id":"/docs/releases","href":"/docs/releases","title":"All Releases"}]},{"title":"Packages","id":"packages","items":[{"id":"/packages/react-tinacms-date","slug":"/packages/react-tinacms-date","title":"react-tinacms-date"},{"id":"/packages/react-tinacms-editor","slug":"/packages/react-tinacms-editor","title":"react-tinacms-editor"},{"id":"/packages/react-tinacms-github","slug":"/packages/react-tinacms-github","title":"react-tinacms-github"},{"id":"/packages/react-tinacms-inline","slug":"/packages/react-tinacms-inline","title":"react-tinacms-inline"},{"id":"/packages/react-tinacms-strapi","slug":"/packages/react-tinacms-strapi","title":"react-tinacms-strapi"},{"id":"/packages/next-tinacms-github","slug":"/packages/next-tinacms-github","title":"next-tinacms-github"},{"id":"/packages/next-tinacms-json","slug":"/packages/next-tinacms-json","title":"next-tinacms-json"},{"id":"/packages/next-tinacms-markdown","slug":"/packages/next-tinacms-markdown","title":"next-tinacms-markdown"},{"id":"/packages/gatsby-plugin-tinacms","slug":"/packages/gatsby-plugin-tinacms","title":"gatsby-plugin-tinacms"},{"id":"/packages/gatsby-tinacms-git","slug":"/packages/gatsby-tinacms-git","title":"gatsby-tinacms-git"},{"id":"/packages/gatsby-tinacms-json","slug":"/packages/gatsby-tinacms-json","title":"gatsby-tinacms-json"},{"id":"/packages/gatsby-tinacms-remark","slug":"/packages/gatsby-tinacms-remark","title":"gatsby-tinacms-remark"}]}],"nextPage":{"slug":"/docs/ui/inline-editing/inline-image","title":"Inline Image"},"prevPage":{"slug":"/docs/ui/inline-editing/inline-textarea","title":"Inline Textarea"}},"__N_SSG":true}