carbon-react
Version:
A library of reusable React components for easily building user interfaces.
41 lines (40 loc) • 1.69 kB
TypeScript
import React from "react";
import { MarginProps } from "styled-system";
import { StyledContentContainerProps, StyledInlineInputsProps } from "./inline-inputs.style";
import { TagProps } from "../../__internal__/utils/helpers/tags";
/**
* @deprecated `InlineInputs` has been deprecated. See the Carbon documentation for migration details.
*/
export interface InlineInputsProps extends MarginProps, StyledContentContainerProps, StyledInlineInputsProps, TagProps {
/** Breakpoint for adaptive label (inline label change to top aligned). Enables the adaptive behaviour when set */
adaptiveLabelBreakpoint?: number;
/** Children elements */
children?: React.ReactNode;
/**
* @private
* @internal
* @ignore
* Sets className for component. INTERNAL USE ONLY. */
className?: string;
/** The id of the corresponding input control for the label */
htmlFor?: string;
/** Defines the label text for the heading. */
label?: string;
/** Inline label alignment */
labelAlign?: "left" | "right";
/**
* Custom label id, could be used in combination with aria-labelledby prop of each input,
* to make them accessible for screen readers.
*/
labelId?: string;
/** Flag to configure component as mandatory. */
required?: boolean;
}
/**
* @deprecated `InlineInputs` has been deprecated. See the Carbon documentation for migration details.
*/
declare const InlineInputs: {
({ adaptiveLabelBreakpoint, label, labelAlign, labelId, htmlFor, children, gutter, inputWidth, labelInline, labelWidth, required, ...rest }: InlineInputsProps): React.JSX.Element;
displayName: string;
};
export default InlineInputs;