Skip to main content

Function: createNarrator()

createNarrator(params): (__namedParameters) => Element

Creates a Narrator component that provides narration context to its children.

To take advantage of the content regeneration and training buttons present in the Narration UI, we need to wrap our UI in a Narrator context, which provides the functionality to regenerate/train when we click the buttons. The easiest way to do that is via createNarrator.

Example:

In a file somewhere in your project:

import {saveExample, regenerateNarration} from './actions/Narrator';
import {createNarrator} from '@narrator-ai/react';

const NarratorProvider = createNarrator({
  actions: {
    saveExample,
    regenerateNarration,
  }
});

export default NarratorProvider;

In your layout file:

import NarratorProvider from './NarratorProvider';

function Layout({children}) {
 return (
    <NarratorProvider>
      {children}
    </NarratorProvider>
  );
}

Parameters​

• params: CreateNarratorProps = {}

Returns​

Function

A React functional component that wraps its children with a NarrationProvider.

Parameters​

• __namedParameters

• __namedParameters.children: ReactNode

Returns​

Element

Defined in​

Provider.tsx:55