wix-style-react
Version:
38 lines (37 loc) • 1.56 kB
JavaScript
export default {
description: 'Audio player enables users to play an uploaded audio file.',
do: ['Use it to play audio files, such as songs or voice messages.'],
dont: [
'Don’t use it to compose video player. Use wix.github.io/playable/ instead.',
],
featureExamples: [
{
title: 'Source',
description: `Pass a link to the audio file source with \`src\` prop. Component detects your file \`format\` from the extension.
In situations where extraction does not work specify a file format with format prop.`,
example: '_source',
},
{
title: 'Preload',
description: `Specify what to download when component is rendered with a preload prop. It supports 3 values:<br/>
 - \`auto\` - use it to download the full file.<br/>
 - \`metadata\` - use it to download file metadata only. Full file will be downloaded when play is clicked.<br/>
 - \`none\` - use it when nothing should be preloaded. File and its data will be downloaded when the user clicks play.<br/>`,
example: '_preload',
},
],
commonUseCaseExamples: [
{
title: 'Form',
description:
'Use an audio player in forms to allow users to listen through an uploaded audio file.',
example: '_form',
},
{
title: 'Inbox',
description:
'Use an audio player to display received voice messages in the inbox. Provide an option to download a message by displaying the icon button inline to the player.',
example: '_inbox',
},
],
};