entry_types/scrolled/package/documentation.yml
toc:
- name: Frontend API
description: |
Main entry point of frontend API to register new content element types.
children:
- frontend_contentElementTypes
- frontend_widgetTypes
- name: Editor API
description: |
Main entry point of editor API to register new content element types.
children:
- editor_contentElementTypes
- name: Components
description: |
React components for building content elements.
children:
- AudioPlayer
- ContentElementBox
- ContentElementFigure
- Figure
- FitViewport
- Image
- Text
- ThemeIcon
- ThirdPartyOptIn
- ThirdPartyOptOutInfo
- VideoPlayer
- name: Hooks
description: |
React hooks to obtain entry data.
children:
- useAdditionalSeedData
- useAudioFocus
- useContentElementEditorState
- useContentElementLifecycle
- useCurrentChapter
- useCredits
- useDarkBackground
- useEntryMetadata
- useFile
- useFileRights
- useI18n
- useIsStaticPreview
- useLegalInfo
- useMediaMuted
- usePortraitOrientation
- useShareProviders
- useShareUrl
- useTheme
- name: Frontend Helpers
description: |
Helper functions that can be used in content elements.
children:
- paletteColor
- name: Spec Support
description: |
Helper functions to use in specs.
children:
- normalizeSeed
- renderInEntry
- renderInContentElement
- renderHookInEntry
- name: Storybook Support
description: |
Helper functions to use in content element stories.
children:
- filePermaId
- storiesOfContentElement