@7span/phoenix-react-ui-actionitems
v1.0.0
Published
A customizable ActionItems component for React applications, built with MUI.
Downloads
2
Maintainers
Readme
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
| Prop | Type | Default | Description |
|---------------|----------|---------|-------------------------------------------------------|
| anchorEl
| object | null
| The DOM element used to set the position of the menu |
| setAnchorEl
| function | null
| Function to set the anchor element for the menu |
| menuItems
| array | []
| 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 | |:-:| ||
Author
- Harshil Patel
Contributing
If you would like to contribute to the project, please follow these steps:
- Fork the repository
- Create a new branch (git checkout -b feature/your-feature)
- Make your changes
- Commit your changes (git commit -m 'Add some feature')
- Push to the branch (git push origin feature/your-feature)
- 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 [[email protected]].
Made with by 7span