freesewing/packages/react/components/Help/index.mjs

import React from 'react'
// Components
import { ModalWrapper } from '@freesewing/react/components/Modal'

/*
 * A component to display an iframe intended for a modal window.
 *
 * All props are passed down to the iframe tag.
 *
 * @component
 * @param {object} props - All component props
 * @returns {JSX.Element}
 */
const Iframe = (props) => (
  <iframe
    {...props}
    style={{ height: '90vh', width: '90vw' }}
    className="tw:w-full tw:mx-auto tw:max-w-4xl"
  />
)

/*
 * A component to display an iframe with FreeSewing.eu docs content intended for a modal window.
 *
 * @component
 * @param {object} props - All component props
 * @param {string} props.path - The (relative) URL path of the page to load
 * @returns {JSX.Element}
 */
const DocsHelp = ({ path }) => (
  <Iframe src={`https://freesewing.eu/${path}/?docusaurus-data-fs-embed=true`} />
)

/*
 * A component to display inline help for a design option
 *
 * This is typically loaded as modal content as it returns an iframe.
 *
 * @component
 * @param {object} props - All component props
 * @param {string} props.design - The design name
 * @param {string} props.o - The option ID
 * @returns {JSX.Element}
 */
const DesignOptionHelp = ({ design, o }) =>
  design && o ? (
    <Iframe
      src={`https://freesewing.eu/docs/designs/${design.toLowerCase()}/options/${o.toLowerCase()}/index.html?docusaurus-data-fs-embed=true`}
      title="Design Options Help"
    />
  ) : (
    <p>Invalid props provided to DesignOptionHelp.</p>
  )

/*
 * A component to display inline help for a core setting
 *
 * This is typically loaded as modal content as it returns an iframe.
 *
 * @component
 * @param {object} props - All component props
 * @param {string} props.name - The core setting name/id
 * @returns {JSX.Element}
 */
const CoreSettingHelp = ({ name }) =>
  name ? (
    <Iframe
      src={`https://freesewing.eu/docs/editor/menus/settings/${name.toLowerCase()}/index.html?docusaurus-data-fs-embed=true`}
      title="Core Setting Help"
    />
  ) : (
    <p>Invalid props provided to CoreSettingsHelp.</p>
  )

/*
 * A component to display inline help for a UI preference
 *
 * This is typically loaded as modal content as it returns an iframe.
 *
 * @component
 * @param {object} props - All component props
 * @param {string} props.name - The core setting name/id
 * @returns {JSX.Element}
 */
const UiPreferenceHelp = ({ name }) =>
  name ? (
    <Iframe
      src={`https://freesewing.eu/docs/editor/menus/preferences/${name.toLowerCase()}/index.html?docusaurus-data-fs-embed=true`}
      title="UI Preferences Help"
    />
  ) : (
    <p>Invalid props provided to UiPreferenceHelp.</p>
  )

/*
 * A component to display inline help for a measurement.
 *
 * This is typically loaded as modal content as it returns an iframe
 *
 * @component
 * @param {object} props - All component props
 * @param {string} [props.m = undefined] - The measurment name (id)
 * @returns {JSX.Element}
 */
const MeasurementHelp = ({ m }) =>
  m ? (
    <iframe
      src={`https://freesewing.eu/docs/measurements/${m.toLowerCase()}/index.html?docusaurus-data-fs-embed=true`}
      title="Measurement Help"
      style={{ height: '90vh', width: '90vw' }}
    />
  ) : (
    <p>No measurement name provided in the m prop.</p>
  )

export function modalCoreSettingHelp(name, setModal) {
  setModal(
    <ModalWrapper fullWidth keepOpenOnClick>
      <CoreSettingHelp name={name} />
    </ModalWrapper>
  )
}

export function modalUiPreferenceHelp(name, setModal) {
  setModal(
    <ModalWrapper fullWidth keepOpenOnClick>
      <UiPreferenceHelp name={name} />
    </ModalWrapper>
  )
}

export function modalDesignOptionHelp(design, o, setModal) {
  setModal(
    <ModalWrapper fullWidth keepOpenOnClick>
      <DesignOptionHelp {...{ design, o }} />
    </ModalWrapper>
  )
}

export function modalMeasurementHelp(m, setModal) {
  setModal(
    <ModalWrapper fullWidth keepOpenOnClick>
      <MeasurementHelp m={m} />
    </ModalWrapper>
  )
}

export function modalDocsHelp(path, setModal) {
  setModal(
    <ModalWrapper wide keepOpenOnClick>
      <DocsHelp path={path} />
    </ModalWrapper>
  )
}