docs(callbacks): updates in typings (#1446)

* docs(callbacks): updates in typings

* docs(readme): add Advertisement component to list

src/collections/Table/Table.d.ts

@@ -66,8 +66,11 @@ interface TableProps {
   padded?: boolean | 'very';
 
   /**
-   * A function that takes (data, index) and returns shorthand for a TableRow
-   * to be placed within Table.Body.
+   * Mapped over `tableData` and should return shorthand for each Table.Row to be placed within Table.Body.
+   *
+   * @param {*} data - An element in the `tableData` array.
+   * @param {number} index - The index of the current element in `tableData`.
+   * @returns {*} Shorthand for a Table.Row.
    */
   renderBodyRow?: (data: any, index: number) => any;
 

src/modules/Accordion/Accordion.d.ts

@@ -30,7 +30,12 @@ interface AccordionProps {
   /** Format for dark backgrounds. */
   inverted?: string;
 
-  /** Called with (event, index) when a panel title is clicked. */
+  /**
+   * Called when a panel title is clicked.
+   *
+   * @param {SyntheticEvent} event - React's original SyntheticEvent.
+   * @param {number} index - The index of the clicked panel.
+   */
   onTitleClick?: (event: React.MouseEvent<HTMLDivElement>, index: number | number[]) => void;
 
   /**

src/modules/Accordion/Accordion.js

@@ -52,7 +52,7 @@ export default class Accordion extends Component {
      * Called when a panel title is clicked.
      *
      * @param {SyntheticEvent} event - React's original SyntheticEvent.
-     * @param {index} - The index of the clicked panel.
+     * @param {number} index - The index of the clicked panel.
      */
     onTitleClick: PropTypes.func,
 

src/modules/Dropdown/Dropdown.d.ts

@@ -192,8 +192,16 @@ export interface DropdownProps {
   /** A dropdown can be formatted so that its menu is pointing. */
   pointing?: boolean | 'left' | 'right' | 'top' | 'top left' | 'top right' | 'bottom' | 'bottom left' | 'bottom right';
 
-  /** A function that takes (data, index, defaultLabelProps) and returns shorthand for Label. */
-  renderLabel?: (item: DropdownItemProps, index: number, defaultProps: LabelProps) => React.ReactElement<any>;
+  /**
+   * Mapped over the active items and returns shorthand for the active item Labels.
+   * Only applies to `multiple` Dropdowns.
+   *
+   * @param {object} item - A currently active dropdown item.
+   * @param {number} index - The current index.
+   * @param {object} defaultLabelProps - The default props for an active item Label.
+   * @returns {*} Shorthand for a Label.
+   */
+  renderLabel?: (item: DropdownItemProps, index: number, defaultLabelProps: LabelProps) => React.ReactElement<any>;
 
   /** A dropdown can have its menu scroll. */
   scrolling?: boolean;

src/modules/Search/Search.d.ts

@@ -59,14 +59,18 @@ interface SearchProps {
   // ------------------------------------
 
   /**
-   * A function that returns the category contents.
-   * Receives all SearchCategory props.
+   * Renders the SearchCategory contents.
+   *
+   * @param {object} props - The SearchCategory props object.
+   * @returns {*} - Renderable SearchCategory contents.
    */
   categoryRenderer?: (props: SearchCategoryProps) => React.ReactElement<any>;
 
   /**
-   * A function that returns the result contents.
-   * Receives all SearchResult props.
+   * Renders the SearchResult contents.
+   *
+   * @param {object} props - The SearchResult props object.
+   * @returns {*} - Renderable SearchResult contents.
    */
   resultRenderer?: (props: SearchResultProps) => Array<React.ReactElement<any>>;
 

src/modules/Search/SearchCategory.d.ts

@@ -20,8 +20,10 @@ export interface SearchCategoryProps {
   name?: string;
 
   /**
-   * A function that returns the category contents.
-   * Receives all SearchCategory props.
+   * Renders the category contents.
+   *
+   * @param {object} props - The SearchCategory props object.
+   * @returns {*} - Renderable category contents.
    */
   renderer?: (props: SearchCategoryProps) => React.ReactElement<any>;
 

src/modules/Search/SearchResult.d.ts

@@ -33,8 +33,10 @@ export interface SearchResultProps {
   price?: string;
 
   /**
-   * A function that returns the result contents.
-   * Receives all SearchResult props.
+   * Renders the result contents.
+   *
+   * @param {object} props - The SearchResult props object.
+   * @returns {*} - Renderable result contents.
    */
   renderer?: (props: SearchResultProps) => Array<React.ReactElement<any>>;