0.3.4 • Published 4 years ago
@bdt-component-library/container v0.3.4
Container Component
About
This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project README.
Description
Serves as a basic, top-level layout container, handling positioning for different child components.
API
| prop | type | required | default | explanation |
|---|---|---|---|---|
| children | React node | yes | n/a | The component/text to render inside the button |
| className | string | no | "" | Adds an optional classname to the component |
| id | string | no | "" | Adds an optional id to the component |
| position | enum("relative", "fixed-top", "fixed-bottom") | no | "relative" | Adds positioning to the container |
| isHorizontallyCentered | boolean | no | false | Determines if the children are centered horizontally (nested layout components may override this) |