deprecating Layout and ItemLayout

microsoft · Apr 2, 2019 · 1a2ac8a · 1a2ac8a
1 parent 14825f7
commit 1a2ac8a
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/docs/src/examples/components/ItemLayout/index.tsx b/docs/src/examples/components/ItemLayout/index.tsx
@@ -1,10 +1,13 @@
 import * as React from 'react'
+import { Alert } from '@stardust-ui/react/'
+
 import Types from './Types'
 import Content from './Content'
 import Rtl from './Rtl'
 
 const ItemLayoutExamples = () => (
   <div>
+    <Alert warning>This component is deprecated</Alert>
     <Types />
     <Content />
     <Rtl />

diff --git a/docs/src/examples/components/Layout/index.tsx b/docs/src/examples/components/Layout/index.tsx
@@ -1,9 +1,12 @@
 import * as React from 'react'
+import { Alert } from '@stardust-ui/react/'
+
 import Types from './Types'
 import Variations from './Variations'
 
 const LayoutExamples = () => (
   <div>
+    <Alert warning>This component is deprecated</Alert>
     <Types />
     <Variations />
   </div>

diff --git a/packages/react/src/components/ItemLayout/ItemLayout.tsx b/packages/react/src/components/ItemLayout/ItemLayout.tsx
@@ -65,7 +65,7 @@ export interface ItemLayoutProps extends UIComponentProps, ContentComponentProps
 }
 
 /**
- * The Item Layout handles layout styles for menu items, list items and other similar item templates.
+ * (DEPRECATED) The Item Layout handles layout styles for menu items, list items and other similar item templates.
  */
 class ItemLayout extends UIComponent<ReactProps<ItemLayoutProps>, any> {
   static create: Function

diff --git a/packages/react/src/components/Layout/Layout.tsx b/packages/react/src/components/Layout/Layout.tsx
@@ -47,7 +47,7 @@ export interface LayoutProps extends UIComponentProps {
 }
 
 /**
- * A layout is a utility for arranging the content of a component.
+ * (DEPRECATED) A layout is a utility for arranging the content of a component.
  */
 class Layout extends UIComponent<ReactProps<LayoutProps>, any> {
   static className = 'ui-layout'