import { ElementType, ComponentPropsWithoutRef, ComponentPropsWithRef, ReactElement } from 'react'; /** * MIT License * * Copyright (c) 2023, Brion Mario. * * 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. */ /** * Interface to be extended to make a component polymorphic. * i.e A polymorphic component is a component that can be rendered with a different container element / node. * * @example * ```jsx * * ``` * In here, `SayHola` container will be an anchor element rather than the usual `div`. */ type PolymorphicComponent = ComponentPropsWithoutRef & { as?: T; }; type PolymorphicRef = ComponentPropsWithRef['ref']; /** * Type definition for the polymorphic SayHola component that renders a greeting. */ type PolymorphicSayHolaComponent = (props: SayHolaProps) => ReactElement | null; /** * The `SayHolaProps` interface represents the props accepted by the `SayHola` component. */ type SayHolaProps = PolymorphicComponent; /** * `SayHola` is a React component * * @remarks This component is also Polymorphic. * * @param props - Props for the component. * @returns SayHola as a React Component. */ declare const SayHola: PolymorphicSayHolaComponent; interface UseSayHolaProps { greeting: string; } declare const useSayHola: (interval?: number, staticMode?: boolean) => { greeting: string; }; export { type PolymorphicComponent, type PolymorphicRef, type SayHolaProps, type UseSayHolaProps, SayHola as default, useSayHola };