@muraldevkit/ui-toolkit 2.15.3 → 2.15.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -27,6 +27,8 @@ export interface MrlIconButtonProps extends Omit<MrlComponentProps, 'style'>, Re
27
27
  icon: React.ReactElement;
28
28
  /**
29
29
  * Changes the visual emphasis of the button.
30
+ *
31
+ * Note: size="xsmall" should ONLY be used with a kind of `ghost` or `ghost-inverse`.
30
32
  */
31
33
  kind?: MrlButtonKind;
32
34
  /**
@@ -39,6 +41,8 @@ export interface MrlIconButtonProps extends Omit<MrlComponentProps, 'style'>, Re
39
41
  position?: MrlTooltipPosition;
40
42
  /**
41
43
  * Changes the size of the button so it can scale with its surrounding context.
44
+ *
45
+ * Note: size="xsmall" should ONLY be used with a kind of `ghost` or `ghost-inverse`.
42
46
  */
43
47
  size?: MrlButtonSize | MrlGhostIconButtonSize;
44
48
  /**
@@ -15,7 +15,11 @@ interface MrlTextHeadingProps {
15
15
  * xsmall and xxsmall are only supported when kind="title"
16
16
  */
17
17
  size?: HeadingSizes | TextSizes;
18
- /** Clear and concise description of the content that the heading describes */
18
+ /**
19
+ * Clear and concise description of the content that the heading describes
20
+ *
21
+ * Note: hierarchy only impacts MrlTextHeading components with `kind="title"`
22
+ */
19
23
  hierarchy?: HeadingHierarchies;
20
24
  text?: string;
21
25
  }