ImFusion Web SDK

useViewVisibility

ts
function useViewVisibility(view: View): {
  hidden: boolean;
  setHidden: (hidden: boolean) => void;
};

Returns the reactive 'hidden' state of a view.

Subscribes to DisplayAutoLayouter.onViewHiddenChanged

Parameters

ParameterTypeDescription
viewViewThe view to observe

Returns

ts
{
  hidden: boolean;
  setHidden: (hidden: boolean) => void;
}

The current 'hidden' state and a function to change it

NameType
hiddenboolean
setHidden()(hidden: boolean) => void

Throws

If called outside of an ImFusionProvider

Throws

If called before the SDK has finished initializing

Example

tsx
function ViewToggle({ view }: { view: View }) {
  const { hidden, setHidden } = useViewVisibility(view);
  return (
    <label>
      <input type="checkbox" checked={!hidden} onChange={(e) => setHidden(!e.target.checked)} />
      Show view
    </label>
  );
}

See

useLayoutMode