documentation icon indicating copy to clipboard operation
documentation copied to clipboard

docs(defaultComponents): remove audio and html component types

Open dfreier opened this issue 1 year ago • 3 comments

I don't think we support audio and html component types here, at least I have not found any other references in the documentation and at a first glance also no explict handling in the code

dfreier avatar Mar 12 '24 12:03 dfreier

It looks like the schema supports it: https://github.com/livingdocsIO/livingdocs-server/blob/609ae837a7fd4acb643bcfad7bbf410eda063b02/app/features/channel-configs/config-properties/content-types.js#L42-L48

JordiVM avatar Mar 12 '24 15:03 JordiVM

@JordiVM @marcbachmann It's a mess 🙈

In components schema we have:

defaultComponents: ms.strictObj({
  paragraph: 'string',
  image: 'string',
  html: 'string'
})

But in the component docs:

Livingdocs knows 3 types of default components:

  • paragraph, automatic insert when a user presses “Enter” in the editor, typically a p tag
  • image, automatic insert when a user drags an image to Livingdocs, e.g. from the Desktop
  • video, automatic insert when a user drags a video to Livingdocs, e.g. from the Desktop

In design schema:

defaultComponents: ms.strictObj({
  paragraph: 'string',
  image: 'string',
  video: 'string',
  audio: 'string',
  html: 'string'
})

In design config example:

defaultComponents: {
  paragraph: 'p',
  image: 'image',
  video: 'video'
}

In content types schema:

defaultComponents: ms.strictObj({
  paragraph: 'string',
  image: 'string',
  video: 'string',
  audio: 'string',
  html: 'string'
})

dfreier avatar Mar 13 '24 12:03 dfreier

We can merge this one and have some efforts to fix this in the future maybe? :)

JordiVM avatar May 10 '24 09:05 JordiVM

:tada: This PR is included in version 1.94.33 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket:

livingdocs-automation avatar May 12 '24 21:05 livingdocs-automation