Skip to main content

Toggle Components

Overview​

Concrete exports some components that use the hook useModal.

  • Modal
  • LightBox
  • Menu

Basic usage​

The basic usage is when you control the state of the Toggle Panel component with open and onClose props.

Example with Lightbox​

import { LightBoxExample, Button } from "@habx/ui-core";

const LightBoxExample = () => (
  <LightBoxExample
    triggerElement={<Button>Open the modal</Button>}
    title="Hi !"
  >
    I'm a modal
  </LightBoxExample>
);

Trigger Element​

Toggle components allow you to pass directly a trigger element so you don't have to handle the open state.

Do not worry about the onClick props and ref, we keep it in your triggerElement

Example with Modal​

import { Modal, Button } from "@habx/ui-core";

const ModalExample = () => (
  <Modal triggerElement={<Button>Open the modal</Button>} title="Hi !">
    <Text>I'm a modal</Text>
  </Modal>
);

Trigger element with modal state​

It is possible to pass a function to triggerElement to access modal state and conditionally render some of the UI accordingly.

const MenuExampleWithComplexTriggerElement = () => (
  <Modal
    triggerElement={(modal) => (
      <Button onClick={modal.onClick}>
        Open the modal ({modal.open ? "opened" : "closed"})
      </Button>
    )}
  >
    <Text>Hi !</Text>
  </Modal>
);

Access modal state​

You can pass a function as child of your Toggle component to access modal state or functions.

Conditional rendering​

It could be useful to conditionally render your components.

State values are opened, opening, closing and closed.

import { Modal, Button } from "@habx/ui-core";

const ModalWithStateContentExample = () => (
  <Modal triggerElement={<Button>Open the modal</Button>} title="Hi !">
    {(modal) => <Text>I'm {modal.state}</Text>}
  </Modal>
);

Closing with render props​

import { Modal, Button } from "@habx/ui-core";

const ModalWithClosingInContentExample = () => (
  <Modal triggerElement={<Button>Open the modal</Button>} title="Hi !">
    {(modal) => <Button onClick={modal.close}>Close</Button>}
  </Modal>
);

Use value as open state​

You can pass value props in Modal and it will be cached from the last time the modal was opening / opened Can be useful if you want to keep Modal UI consistent during closing phase while resetting your application state.

const MyComponent = () => {
  const [value, setValue] = React.useState(null);
  return (
    <Modal
      open={!!selectedRow}
      onClise={() => setValue(null)}
      value={selectedRow}
    >
      {(modal) =>
        modal.state !== ModalState.closed && <Component value={modal.value} />
      }
    </Modal>
  );
};