Types.ts

/*
 * Copyright (c) 2024. Devtron Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

export interface Breadcrumb {
    to: string
    name: string
    className?: string
}

export interface UseBreadcrumbState {
    breadcrumbs: Breadcrumb[]
    setCrumb: (props: { [key: string]: any }) => void
    resetCrumb: (props: string[]) => void
}

export interface AdvancedAlias {
    component: any
    linked: boolean
}

export interface UseBreadcrumbProps {
    sep?: string
    alias?: { [key: string]: AdvancedAlias | any }
}

export interface Breadcrumbs {
    breadcrumbs: Breadcrumb[]
    path: string
    sep?: string
    className?: string
}

export type UseBreadcrumbOptionalProps = UseBreadcrumbProps | null

export interface BreadcrumbTextProps {
    heading: string
    isActive?: boolean
    /**
     * @default false
     */
    shouldTruncate?: boolean
}

export interface NestedBreadCrumbProps {
    /**
     * It is the url to which the link should redirect
     */
    redirectUrl: string
    /**
     * It is the text of the link
     */
    linkText: string
    /**
     * It is the name of the profile
     * If not given, would show "Create Profile"
     */
    profileName: string
    /**
     * @default Profiles
     * It is the text of the nested breadcrumb
     */
    nestedBreadCrumbsText?: string
}