@metamask/snaps-sdk
Version:
A library containing the core functionality for building MetaMask Snaps
41 lines • 1.34 kB
text/typescript
import type { FooterElement } from "./Footer.mjs";
import type { GenericSnapElement } from "../component.mjs";
/**
* Definition of container background colors.
*/
export type ContainerBackgroundColor = 'default' | 'alternative';
/**
* The props of the {@link Container} component.
*
* @property children - The Box and the Footer or the Box element.
*/
export type ContainerProps = {
children: [GenericSnapElement, FooterElement] | GenericSnapElement;
backgroundColor?: ContainerBackgroundColor | undefined;
};
/**
* A container component, which is used to create a container with a box and a footer.
*
* @param props - The props of the component.
* @param props.backgroundColor - The color of the background.
* @param props.children - The Box and the Footer or the Box element.
* @returns A container element.
* @example
* <Container backgroundColor="default">
* <Box>
* <Text>Hello world!</Text>
* </Box>
* <Footer>
* <Button name="cancel">Cancel</Button>
* <Button name="confirm">Confirm</Button>
* </Footer>
* </Container>
*/
export declare const Container: import("../component.mjs").SnapComponent<ContainerProps, "Container">;
/**
* A container element.
*
* @see Container
*/
export type ContainerElement = ReturnType<typeof Container>;
//# sourceMappingURL=Container.d.mts.map