1.0.0 • Published 1 year ago

@7span/phoenix-react-ui-actionitems v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Custom ActionItems Component

ActionItems is a React component that renders a customizable menu using Material-UI's Menu and MenuItem components. It supports displaying a list of menu items with icons and optional dividers between the items.

Features

  • Displays a menu with customizable menu items and icons
  • Supports dividers between menu items
  • Handles click events for each menu item

Installation

Install the necessary dependencies:

npm install @mui/material @emotion/react @emotion/styled

Install the package via npm:

npm install @7span/phoenix-react-ui-actionitems

Or via yarn:

yarn add @7span/phoenix-react-ui-actionitems

Usage

Here's a basic example of how to use the custom Sidebar component in your React application:

import React, { useState } from "react";
import ActionItems from "@7span/phoenix-react-ui-actionitems";
import { Icon1, Icon2 } from "@mui/icons-material"; // Replace with your actual icons

const MyComponent = () => {
  const [anchorEl, setAnchorEl] = useState(null);

  const menuItems = [
    {
      name: "Item 1",
      icon: Icon1,
      onClick: () => console.log("Item 1 clicked"),
    },
    {
      name: "Item 2",
      icon: Icon2,
      onClick: () => console.log("Item 2 clicked"),
    },
  ];

  const handleClick = (event) => {
    setAnchorEl(event.currentTarget);
  };

  const handleClose = () => {
    setAnchorEl(null);
  };

  return (
    <div>
      <button onClick={handleClick}>Open Menu</button>
      <ActionItems anchorEl={anchorEl} setAnchorEl={setAnchorEl} menuItems={menuItems} />
    </div>
  );
};

export default MyComponent;

Props

PropTypeDefaultDescription
anchorElobjectnullThe DOM element used to set the position of the menu
setAnchorElfunctionnullFunction to set the anchor element for the menu
menuItemsarray[]Array of menu items to be displayed in the menu

Customization

You can customize the styles of the ActionItems component and its elements by modifying the sx prop in the component's JSX.

Images

Actions Menu
Action Image

Author

  • Harshil Patel

Contributing

If you would like to contribute to the project, please follow these steps: 1. Fork the repository 2. Create a new branch (git checkout -b feature/your-feature) 3. Make your changes 4. Commit your changes (git commit -m 'Add some feature') 5. Push to the branch (git push origin feature/your-feature) 6. Open a Pull Request

License

This project is licensed under the MIT License

Contact

If you have any questions or suggestions, feel free to open an issue or contact me directly at yo@7span.com.

Made with by 7span

This README.md file provides comprehensive details about the ActionItems component, including installation instructions, usage examples, prop descriptions, customization options, and the actual component code. Let me know if you need any more adjustments!