Package Exports
- @instructure/ui-layout
- @instructure/ui-layout/lib/ContextView
- @instructure/ui-layout/lib/DrawerLayout
- @instructure/ui-layout/lib/Flex
- @instructure/ui-layout/lib/Grid
- @instructure/ui-layout/lib/LayoutPropTypes
- @instructure/ui-layout/lib/LayoutPropTypes.js
- @instructure/ui-layout/lib/Position
- @instructure/ui-layout/lib/Position/locator
- @instructure/ui-layout/lib/Responsive
- @instructure/ui-layout/lib/View
- @instructure/ui-layout/lib/calculateElementPosition
- @instructure/ui-layout/lib/mirrorHorizontalPlacement
- @instructure/ui-layout/lib/mirrorHorizontalPlacement.js
- @instructure/ui-layout/lib/parsePlacement
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@instructure/ui-layout) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
category: packages
ui-layout
Installation
yarn add @instructure/ui-layoutUsage
import React from 'react'
import { DrawerLayout } from '@instructure/ui-layout'
const MyLayout = () => {
return (
<DrawerLayout>
<DrawerLayout.Tray>Hello from layout tray</DrawerLayout.Tray>
<DrawerLayout.Content>Hello from layout content</DrawerLayout.Content>
</DrawerLayout>
)
}Deprecated components
The following components have been deprecated and will be removed from the ui-layout package:
- Flex (use Flex from ui-flex instead)
- Grid (use Grid from ui-grid instead)
- Media (use Byline from ui-byline instead)
- Position (use Position from ui-position instead)
- Responsive (use Responsive from ui-responsive instead)
- View (use View from ui-view instead)
- ContextView (use ContextView from ui-view instead)
- DrawerLayout (use DrawerLayout from ui-drawer-layout instead)
Codemods are provided to assist in updating the packages. See ui-codemods
Utilities
The ui-layout package contains the following utilities:
Contribute
See the contributing guidelines for details.