/** * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). * * WSO2 LLC. licenses this file to you 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. */ import type { OverridableComponent } from '@mui/material/OverridableComponent'; import { SelectProps as MuiSelectProps } from '@mui/material/Select'; import type { ElementType } from 'react'; import type { BoxProps, BoxTypeMap } from '../Box'; import type { InputLabelProps } from '../InputLabel'; import type { OutlinedInputProps } from '../OutlinedInput'; import './phone-number-input.scss'; export type PhoneNumberInputProps = BoxProps & { /** * Props sent to the InputLabel component. * * Refer props: {@link https://mui.com/material-ui/api/input-label/} */ InputLabelProps?: InputLabelProps; /** * Props sent to the OutlinedInput component. * * Refer props: {@link https://mui.com/material-ui/api/outlined-input/} */ OutlinedInputProps?: Omit; /** * Props sent to the Select component. * * Refer props: {@link https://mui.com/material-ui/api/select/} */ SelectProps?: Omit; /** * Dial code state value. * * @example '+94' */ dialCodeValue?: string; /** * Label for the phone number input. */ label: string; /** * Callback function to be called when the dialCode or phoneNumber changes. */ onChange?: (dialCode: string, phoneNumber: string) => void; /** * Phone number state value. * * @example '787878787' */ phoneNumberValue?: string; /** * Placeholder text for the phone number input. */ placeholder?: string; }; /** * The Phone Number Input component is used to get the phone number input from the user. * * Demos: * * - [Phone Number Input (Oxygen UI)](https://wso2.github.io/oxygen-ui/react/?path=/docs/inputs-phone-number-input) * * API: * * - inherits [Box API](https://mui.com/material-ui/api/box/) * * @remarks * - ✨ This is a custom component that is not available in the Material-UI library. * - ✔️ Props of the [Box](https://mui.com/material-ui/api/box/) component are also available. * - ✅ `component` prop is supported. * - ✅ The `ref` is forwarded to the root element. * * @template C - The type of the component. * @param props - The props for the PhoneNumberInput component. * @param ref - The ref to be forwarded to the Box component. * @returns The rendered PhoneNumberInput component. */ declare const PhoneNumberInput: OverridableComponent>; export default PhoneNumberInput;