@atlaskit/menu 1.3.4 → 1.3.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/menu
 
+## 1.3.5
+
+### Patch Changes
+
+- [`efa50ac72ba`](https://bitbucket.org/atlassian/atlassian-frontend/commits/efa50ac72ba) - Adjusts jsdoc strings to improve prop documentation
+
 ## 1.3.4
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/menu",
-	"version": "1.3.4",
+	"version": "1.3.5",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/menu",
-	"version": "1.3.4",
+	"version": "1.3.5",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/menu",
-	"version": "1.3.4",
+	"version": "1.3.5",
 	"sideEffects": false
 }

package/dist/types/types.d.ts

@@ -94,7 +94,7 @@ export interface SectionProps {
     overrides?: {
         HeadingItem?: {
             /**
-             * A function that can be used to override the styles of the component.
+             * A function that overrides the styles of the component.
              * It receives the current styles and state and expects a styles object.
              */
             cssFn?: StatelessCSSFn;
@@ -127,10 +127,10 @@ export interface MenuItemPrimitiveProps {
 }
 export interface MenuItemProps {
     /**
-     * A function that can be used to override the styles of the component.
-     * It receives the current styles and state and expects a styles object.
-     *
-     * @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
+      A function that overrides the styles of the component.
+      It receives the current styles and state and expects a styles object.
+  
+      @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
      */
     cssFn?: CSSFn;
     /**
@@ -175,9 +175,9 @@ export interface MenuItemProps {
      */
     testId?: string;
     /**
-     * Custom overrides for the composed components.
-     *
-     * @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
+      Custom overrides for the composed components.
+  
+      @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
      */
     overrides?: Overrides;
     /**
@@ -266,14 +266,16 @@ export interface CustomItemComponentProps {
 }
 export interface CustomItemProps<TCustomComponentProps = CustomItemComponentProps> extends MenuItemProps {
     /**
-     * Custom component to render as an item.
-     * This can be both a functional component or a class component.
-     * __Will return `null` if no component is defined.__
-     * If using TypeScript and this has typed props it will make its props available to the root custom item component for type safety,
-     * which allows you to pass the custom component's props via the root custom item component props.
-     * e.g. `<CustomItem to="/link" component={RouterLink} />`
-     *
-     * __NOTE:__ Make sure the reference for this component does not change between renders else undefined behavior may happen.
+      Custom component to render as an item. This can be both a functional component or a class component.
+  
+      __Will return `null` if no component is defined.__
+  
+      Props passed to `CustomItem` will be passed down to this component. If the props for `component` have TypeScript types,
+      CustomItem will extend them, providing type safety for your custom item.
+  
+      e.g. `<CustomItem to="/link" component={RouterLink} />`
+  
+      __NOTE:__ Make sure the reference for this component does not change between renders else undefined behavior may happen.
      */
     component?: React.ComponentType<TCustomComponentProps>;
 }
@@ -305,17 +307,17 @@ export interface SkeletonItemProps {
      */
     isShimmering?: boolean;
     /**
-     * A function that can be used to override the styles of this component.
+     * A function that overrides the styles of this component.
      * It receives the current styles and returns a customized styles object.
      */
     cssFn?: StatelessCSSFn;
 }
 export interface HeadingItemProps {
     /**
-     * A function that can be used to override the styles.
-     * It receives the current styles and returns a customised styles object.
-     *
-     * @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
+     A function that overrides the styles.
+     It receives the current styles and returns a customized styles object.
+  
+     @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
      */
     cssFn?: StatelessCSSFn;
     /**
@@ -353,10 +355,10 @@ export interface SkeletonHeadingItemProps {
      */
     isShimmering?: boolean;
     /**
-     * A function that can be used to override the styles of this component.
-     * It receives the current styles and returns a customized styles object.
-     *
-     * @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
+      A function that overrides the styles of this component.
+      It receives the current styles and returns a customized styles object.
+  
+      @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
      */
     cssFn?: StatelessCSSFn;
 }
@@ -365,12 +367,12 @@ export declare type ItemState = {
     isDisabled: boolean;
 };
 /**
- * A function that can be used to override the styles of
- * menu components. It receives the current state
- * and should return a CSSObject.
- *
- * @see @atlaskit/menu/docs/85-overriding-item-styles
- * @deprecated This type is deprecated and will be removed in a future release. See DSP-2676 for more information.
+  A function that overrides the styles of
+  menu components. It receives the current state
+  and should return a CSSObject.
+
+  @see @atlaskit/menu/docs/85-overriding-item-styles
+  @deprecated This type is deprecated and will be removed in a future release. See DSP-2676 for more information.
  */
 export interface CSSFn<TState = ItemState extends void ? void : ItemState> {
     (currentState: TState): CSSObject | CSSObject[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/menu",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "A collection of composable menu components that can be used anywhere.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"