@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
62 lines (61 loc) • 1.82 kB
TypeScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import type React from 'react';
import { type PolymorphicForwardRefExoticComponent } from '../_common/types';
import { type Radius, type Spacing } from './types';
type BaseBoxProps = {
/**
* @default tokens.space['4']
*/
padding?: Spacing;
/**
* @default undefined
*/
paddingBlockStart?: Spacing;
/**
* @default undefined
*/
paddingBlockEnd?: Spacing;
/**
* @default undefined
*/
paddingInline?: Spacing;
/**
* @default undefined
*/
paddingInlineStart?: Spacing;
/**
* @default undefined
*/
paddingInlineEnd?: Spacing;
/**
* @default undefined
*/
borderRadius?: Radius;
children?: React.ReactNode;
style?: React.CSSProperties;
};
/**
* Box is a general-purpose container that allows for controlled use of design tokens.
* Use the given props to configure display behavior and styling that aligns with Needle's tokens.
*/
export declare const Box: PolymorphicForwardRefExoticComponent<'div', BaseBoxProps>;
export {};