Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
react-offcanvas
Advanced tools
Readme
Off-canvas menus for React.
$ npm install --save react-offcanvas
<OffCanvas
width={300}
transitionDuration={300}
isMenuOpened={false}
position={"left"}
effect={"overlay"}
>
<OffCanvasBody className={"my-body-class"} style={{ fontSize: "18px" }}>
This is the canvas body.
</OffCanvasBody>
<OffCanvasMenu className={"my-menu-class"} style={{ fontWeight: "bold" }}>
This is the canvas menu.
</OffCanvasMenu>
</OffCanvas>
You'll need to hook up your application to handle the state for toggling the menu. Check out the basic example below:
"use strict";
import React, { Component } from "react";
import { OffCanvas, OffCanvasMenu, OffCanvasBody } from "react-offcanvas";
export default class App extends Component {
componentWillMount() {
// sets the initial state
this.setState({
isMenuOpened: false
});
}
render() {
return (
<OffCanvas
width={300}
transitionDuration={300}
effect={"parallax"}
isMenuOpened={this.state.isMenuOpened}
position={"right"}
>
<OffCanvasBody
className={styles.bodyClass}
style={{ fontSize: "30px" }}
>
<p>This is the main body container.</p>
<p>
<a href="#" onClick={this.handleClick.bind(this)}>
Click here
</a>{" "}
to toggle the menu.
</p>
</OffCanvasBody>
<OffCanvasMenu className={styles.menuClass}>
<p>Placeholder content.</p>
<ul>
<li>Link 1</li>
<li>Link 2</li>
<li>Link 3</li>
<li>Link 4</li>
<li>Link 5</li>
<li>
<a href="#" onClick={this.handleClick.bind(this)}>
Toggle Menu
</a>
</li>
</ul>
</OffCanvasMenu>
</OffCanvas>
);
}
handleClick() {
// toggles the menu opened state
this.setState({ isMenuOpened: !this.state.isMenuOpened });
}
}
OffCanvas
This is the main component you will be using to compose your body and menu.
Prop | Type | Default | Description |
---|---|---|---|
width | number | 250 | The width of the menu and off-canvas transition. |
transitionDuration | number | 250 | The time in ms for the transition. |
isMenuOpened | bool | false | Is the menu opened or not. |
position | string | "left" | Position the menu to the "left" or "right". |
effect | string | "push" | Choose menu effect. "push", "overlay" or "parallax". |
OffCanvasBody
Prop | Type | Default | Description |
---|---|---|---|
width | number | 250 | The width of the menu and off-canvas transition. |
transitionDuration | number | 250 | The time in ms for the transition. |
isMenuOpened | bool | false | Is the menu opened or not. |
position | string | "left" | Position the menu to the "left" or "right". |
className | string | Custom className for the element. | |
style | object | CSS style object for the element. |
OffCanvasMenu
Prop | Type | Default | Description |
---|---|---|---|
width | number | 250 | The width of the menu and off-canvas transition. |
transitionDuration | number | 250 | The time in ms for the transition. |
isMenuOpened | bool | false | Is the menu opened or not. |
position | string | "left" | Position the menu to the "left" or "right". |
className | string | Custom className for the element. | |
style | object | CSS style object for the element. |
FAQs
Off-canvas menus for React.
The npm package react-offcanvas receives a total of 234 weekly downloads. As such, react-offcanvas popularity was classified as not popular.
We found that react-offcanvas demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.