/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 - present Instructure, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
import React from 'react'

import type {
  SideNavBarTheme,
  OtherHTMLAttributes
} from '@instructure/shared-types'
import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'

type SideNavBarOwnProps = {
  /**
   * When minimized is set to true, the `<SideNavBar />` shows icons only while the text becomes a tooltip. When it is set to false, the `<SideNavBar />` shows text in addition to the icons
   */
  minimized?: boolean
  /**
   * Whether the `<SideNavBar />` is initially minimized (uncontrolled)
   */
  defaultMinimized?: boolean
  onMinimized?: (event: React.SyntheticEvent, minimized: boolean) => void
  /**
   * Screen reader label for the main SideNavBar
   */
  label: string
  /**
   * Screen reader label for the toggle button expanded/minimized state
   */
  toggleLabel: {
    expandedLabel?: string
    minimizedLabel?: string
  }
  /**
   * If the `<SideNavBar.Item>` goes to a new page, pass an href
   */
  href?: string
  /**
   * If the `<SideNavBar.Item>` does not go to a new page pass an onClick
   */
  onClick?: (event: React.MouseEvent) => void
  /**
   * children of type SideNavBar.Item
   */
  children?: React.ReactNode
}

type SideNavBarState = {
  minimized: boolean
}

type PropKeys = keyof SideNavBarOwnProps

type AllowedPropKeys = Readonly<Array<PropKeys>>

type SideNavBarProps = SideNavBarOwnProps &
  WithStyleProps<SideNavBarTheme, SideNavBarStyle> &
  OtherHTMLAttributes<SideNavBarOwnProps>

type SideNavBarStyle = ComponentStyle<
  'navigation' | 'list' | 'content' | 'toggleIcon'
>
const allowedProps: AllowedPropKeys = [
  'children',
  'minimized',
  'defaultMinimized',
  'onMinimized',
  'label',
  'toggleLabel',
  'href',
  'onClick'
]

export type { SideNavBarProps, SideNavBarState, SideNavBarStyle }
export { allowedProps }