react-magma-dom 4.9.0-next.11 → 4.9.0-next.13

package/dist/components/DefinitionList/DefinitionList.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { ListProps } from '../List';
+/**
+ * @children required
+ */
+export interface DefinitionListProps extends Pick<ListProps, 'isInverse' | 'testId' | 'theme' | 'visualStyle'>, React.HTMLAttributes<HTMLDListElement> {
+}
+export declare const DefinitionList: React.ForwardRefExoticComponent<DefinitionListProps & React.RefAttributes<HTMLDListElement>>;

package/dist/components/DefinitionList/DefinitionListItem.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { DefinitionListProps } from './DefinitionList';
+export declare enum DefinitionListType {
+    /**
+     * Represents the term in a definition list.
+     * Will be wrapped in a <dt> (definition term) tag.
+     */
+    term = "term",
+    /**
+     * Represents the description of a term.
+     * Will be wrapped in a <dd> (definition description) tag.
+     */
+    description = "description"
+}
+export interface DefinitionListItemProps extends DefinitionListProps, React.HTMLAttributes<HTMLDListElement> {
+    /**
+     * Types of definition list element.
+     * term: uses a <dt> (definition term) tag
+     * description: uses a <dd> (definition description) tag
+     */
+    type: DefinitionListType;
+}
+export declare const DefinitionListItem: React.ForwardRefExoticComponent<DefinitionListItemProps & React.RefAttributes<HTMLDListElement>>;

package/dist/components/DefinitionList/index.d.ts

@@ -0,0 +1,2 @@
+export * from './DefinitionList';
+export * from './DefinitionListItem';

package/dist/components/List/ListItem.d.ts

@@ -6,6 +6,8 @@ import { ListProps } from './';
  */
 export interface ListItemProps extends ListProps, React.HTMLAttributes<HTMLDivElement> {
     /**
+     * @deprecated = true
+     * Please use DefinitionList instead
      * Boolean which changes a list item into a styled paragraph.
      */
     description?: boolean;