useAddOns

A custom React hook that retrieves the AddOnContext, throwing an error if used outside an AddOnProvider.

Installation

import { useAddOns } from 'uxp/components';

Signature

function useAddOns(): AddOnContextType

Examples

const MyComponent = () => {
  const { addOns, isAddOn } = useAddOns();
  return (
    <div>
      {addOns.map(addOn => (
        <p key={addOn.id}>{addOn.title}: {isAddOn(addOn.id) ? 'Add-On' : 'Not an Add-On'}</p>
      ))}
    </div>
  );
};

PreviousHooks NextuseAlert

Last updated 1 month ago

const MyComponent = () => {
  const { getAddOnDetails, getThunmbNailImagePath } = useAddOns();
  const addOn = getAddOnDetails('module-1');
  return (
    <div>
      {addOn && (
        <div>
          <h2>{addOn.title}</h2>
          <img src={getThunmbNailImagePath('module-1')} alt={addOn.title} />
        </div>
      )}
    </div>
  );
};