openmrs-esm-core

O3 Framework / useRenderableExtensions

Function: useRenderableExtensions()

useRenderableExtensions(name): FC<Pick<ExtensionProps, "state">>[]

Defined in: packages/framework/esm-react-utils/src/useRenderableExtensions.tsx:31

This is an advanced hook for use-cases where its useful to use the extension system, but not the ExtensionSlot component’s rendering of extensions. Use of this hook should be avoided if possible.

Functionally, this hook is very similar to the ExtensionSlot component, but whereas an ExtensionSlot renders a DOM tree of extensions bound to the slot, this hook simply returns the extensions as an array of React components that can be wired into a component however makes sense.

Parameters

name

string

The name of the extension slot

Returns

FC<Pick<ExtensionProps, "state">>[]

Example

const extensions = useRenderableExtensions('my-extension-slot');
return (
 <>
   {extensions.map((Ext, index) => (
     <React.Fragment key={index}>
       <Ext state= />
     </React.Fragment>
   ))}
 </>
)

This site is open source. Improve this page.