@stack-spot/citric-react 0.10.2 → 0.11.0

package/dist/components/MenuOverlay/Menu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Menu.d.ts","sourceRoot":"","sources":["../../../src/components/MenuOverlay/Menu.tsx"],"names":[],"mappings":"AASA,OAAO,EAAsD,SAAS,EAAa,MAAM,SAAS,CAAA;AAiFlG;;GAEG;AACH,wBAAgB,IAAI,CAClB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,EAAE,SAAS,2CAqDlI"}
+{"version":3,"file":"Menu.d.ts","sourceRoot":"","sources":["../../../src/components/MenuOverlay/Menu.tsx"],"names":[],"mappings":"AASA,OAAO,EAAyC,SAAS,EAA0B,MAAM,SAAS,CAAA;AAiFlG;;GAEG;AACH,wBAAgB,IAAI,CAClB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,EAAE,SAAS,2CAqDlI"}

package/dist/components/MenuOverlay/types.d.ts

@@ -55,7 +55,7 @@ interface ItemWithIcon {
      */
     iconRight?: React.ReactElement;
 }
-export interface ListAction extends ItemWithIcon, Action {
+export interface MenuAction extends ItemWithIcon, Action {
     /**
      * Whether or not this option is currently active.
      */
@@ -65,7 +65,7 @@ export interface ListAction extends ItemWithIcon, Action {
      */
     className?: string;
 }
-interface ListGroup {
+interface MenuGroup {
     /**
      * If this group is rendered as a section with its items right below it or a collapsible, which requires a click to open a submenu.
      */
@@ -73,37 +73,37 @@ interface ListGroup {
     /**
      * The items of this group.
      */
-    children: ListItem[];
+    children: MenuItem[];
     /**
     * A class to be added to this item.
     */
     className?: string;
 }
-export interface ListSection extends ListGroup {
+export interface MenuSection extends MenuGroup {
     type: 'section';
     /**
      * The section's title.
      */
     label?: string;
 }
-export interface ListCollapsible extends ListGroup, ItemWithIcon {
+export interface MenuCollapsible extends MenuGroup, ItemWithIcon {
     type?: 'collapsible';
     /**
      * The title of the collapsible menu.
      */
     label: string;
 }
-export type ListItem = ListSection | ListCollapsible | ListAction;
+export type MenuItem = MenuSection | MenuCollapsible | MenuAction;
 export interface MenuState {
-    items: ListItem[];
+    items: MenuItem[];
     parent?: MenuState;
     label?: string;
 }
 export interface BaseMenuProps {
     /**
-     * The options in the selection list.
+     * The options in the menu.
      */
-    items: ListItem[];
+    items: MenuItem[];
     /**
      * A header for the menu.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stack-spot/citric-react",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "author": "StackSpot",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/components/MenuOverlay/Menu.tsx

@@ -7,12 +7,12 @@ import { IconButton } from '../IconBox'
 import { useOverlayController } from '../Overlay/context'
 import { MenuProvider, useMenuController, useMenuState } from './context'
 import { keyboardNavigation } from './keyboard'
-import { ListAction, ListCollapsible, ListItem, ListSection, MenuProps, MenuState } from './types'
+import { MenuAction, MenuCollapsible, MenuItem, MenuProps, MenuSection, MenuState } from './types'
 
 // Arbitrary time (ms) to wait before running a function that needs the view to be updated with the next state value.
 const RENDER_DELAY = 20
 
-function Submenu({ children, label, className, icon, iconRight }: ListCollapsible) {
+function Submenu({ children, label, className, icon, iconRight }: MenuCollapsible) {
   const controller = useMenuController()
   return (
     <button
@@ -37,7 +37,7 @@ function Submenu({ children, label, className, icon, iconRight }: ListCollapsibl
   )
 }
 
-function MenuSection({ children, label, className }: ListSection) {
+function MenuSection({ children, label, className }: MenuSection) {
   return (
     <section className={className}>
       {label && <h6>{label}</h6>}
@@ -49,7 +49,7 @@ function MenuSection({ children, label, className }: ListSection) {
   )
 }
 
-function MenuAction({ label, active, href, icon, iconRight, className, onClick, ...props }: ListAction) {
+function MenuAction({ label, active, href, icon, iconRight, className, onClick, ...props }: MenuAction) {
   const overlayController = useOverlayController()
   const children = <>
     {icon}
@@ -72,15 +72,15 @@ function MenuAction({ label, active, href, icon, iconRight, className, onClick,
   )
 }
 
-function hasSections(items: ListItem[]) {
+function hasSections(items: MenuItem[]) {
   return items.some(i => 'children' in i && i.children.length && i.type === 'section')
 }
 
-function hasSubmenus(items: ListItem[]) {
+function hasSubmenus(items: MenuItem[]) {
   return items.some(i => 'children' in i && i.children.length && i.type === 'collapsible')
 }
 
-function MenuItems({ items }: { items: ListItem[] }) {
+function MenuItems({ items }: { items: MenuItem[] }) {
   return useMemo(() => items.map((item, index) => {
     if ('children' in item && item.type === 'section') return <MenuSection key={item.label || index} {...item} />
     if ('children' in item && item.type === 'collapsible') return <Submenu key={item.label || index} {...item} />

package/src/components/MenuOverlay/types.ts

@@ -59,7 +59,7 @@ interface ItemWithIcon {
   iconRight?: React.ReactElement,
 }
 
-export interface ListAction extends ItemWithIcon, Action {
+export interface MenuAction extends ItemWithIcon, Action {
   /**
    * Whether or not this option is currently active.
    */
@@ -70,7 +70,7 @@ export interface ListAction extends ItemWithIcon, Action {
   className?: string,
 }
 
-interface ListGroup {
+interface MenuGroup {
   /**
    * If this group is rendered as a section with its items right below it or a collapsible, which requires a click to open a submenu.
    */
@@ -78,14 +78,14 @@ interface ListGroup {
   /**
    * The items of this group.
    */
-  children: ListItem[],
+  children: MenuItem[],
   /**
   * A class to be added to this item.
   */
   className?: string,
 }
 
-export interface ListSection extends ListGroup {
+export interface MenuSection extends MenuGroup {
   type: 'section',
   /**
    * The section's title.
@@ -93,7 +93,7 @@ export interface ListSection extends ListGroup {
   label?: string,
 }
 
-export interface ListCollapsible extends ListGroup, ItemWithIcon {
+export interface MenuCollapsible extends MenuGroup, ItemWithIcon {
   type?: 'collapsible',
   /**
    * The title of the collapsible menu.
@@ -101,19 +101,19 @@ export interface ListCollapsible extends ListGroup, ItemWithIcon {
   label: string,
 }
 
-export type ListItem = ListSection | ListCollapsible | ListAction
+export type MenuItem = MenuSection | MenuCollapsible | MenuAction
 
 export interface MenuState {
-  items: ListItem[],
+  items: MenuItem[],
   parent?: MenuState,
   label?: string,
 }
 
 export interface BaseMenuProps {
   /**
-   * The options in the selection list.
+   * The options in the menu.
    */
-  items: ListItem[],
+  items: MenuItem[],
   /**
    * A header for the menu.
    */