import { ReactNode } from 'react'

export interface LinkRenderProp {
  (props?: LinkProps): ReactNode
}

/**
 * PROPS
 */
export interface LinkProps {
  // used to set className for the a tag
  className?: any

  // this class will be used later for React Router
  activeClassName?: string

  // used to set-text/add-children for the <a>/<Link> tag
  text?: string
  children?: ReactNode

  // title is passthrough

  /**
   * @todo @requires href|to|link|url|onClick
   *
   * Have to use any one of, not multiple
   * since below are the props are doing same job
   * this is created for only user-friendly
   */
  href?: string
  // alias props for the href
  to: any
  link?: string
  url?: string
  onClick?: Function

  /**
   * used to set the prefix for the url
   * will be very useful the when the url has relative url
   */
  urlBase?: string

  // open in a new tab/window/same window
  target?: string

  /**
   * used to set role="nofollow"
   * https://support.google.com/webmasters/answer/96569?hl=en
   */
  nofollow?: boolean

  // alias props for the nofollow
  shouldNotFollow?: boolean

  /**
   * Reusable renderProps
   */
  renderLink?: LinkRenderProp
  renderChildren?: LinkRenderProp
}