react-authless-admin v1.0.18

Documentation

Read the official documentation.

👁️ Live Demo

Overview

This project features a simple, local-storage-based means of hiding nonsensitive admin-only content from non-admins on sites that lack user authentication.

Some examples include Edit Content links at the end of posts, links to analytics, and links to other useful admin-only pages.

Just wrap your admin-only content in an AdminOnly tag and reveal it with useAdmin.

Features include:

• 🎛️ Add admin-only controls to your authless site
  • Make life easier for admins without adding useless clutter for non-admins.
• 🌞 Simplest solution
  • Hide nonsensitive admin content without the overkill of external auth dependency.
• 🌐 Site-wide and persistent between sessions
  • One setting to affect the whole site. Uses local storage for persistence.
• 🙈 Cater content to both non-admins and admins
  • Show and hide content from both types of users, simulating the feel of being logged in.
• 👩‍🎨 Admin role support
  • Show or hide content for different admin roles using custom local storage key names.
• 📝 Netlify CMS button
  • Using Netlify CMS? A button is included to make linking to collections and entries easy.

Why use this?

Imagine you have a piece of content on a static Jamstack blog that has no user login system. You author the content yourself, maybe with Netlify CMS, in markdown and trigger a build and deploy on every publish.

As an admin, when viewing your site you want to be able to easily edit this content without having to search for it manually either in GitHub or Netlify CMS. A server-based CMS like WordPress would show you an Edit Content button, but since our site has no concept of user auth, it has no idea you're an admin.

You could integrate with an external auth system, but there's a much simpler way.

With react-authless-admin, you can wrap your admin-only links in AdminOnly and they will show up site-wide when toggled by useAdmin. Similarly, you can wrap any content for non-admin users inside NonAdminOnly.

This allows you to easily control content that's useless to general users, but useful if you're an admin, without needing an auth integration. Check out the demo for an example.

Installation

npm i react-authless-admin

Quick Start

• Hide content from non-admins with AdminOnly.
• Hide content from admins with NonAdminOnly.
• Use the useAdmin hook to switch admin on and off.

import { AdminOnly, NonAdminOnly, useAdmin } from "react-authless-admin";

const [isAdmin, setIsAdmin] = useAdmin();

<button onClick={() => setIsAdmin(!isAdmin)}>{ isAdmin ? 'Switch Off' : 'Switch On' }</button>
<AdminOnly>
  This content is only visible when admin is enabled.
</AdminOnly>
<NonAdminOnly>
  This content is only visible when admin is disabled.
</NonAdminOnly>

The above will show a button that toggles admin on and off, and will toggle two elements on the page.

See the demo for an example of using a passcode to reveal admin-only components to manage a post.

TypeScript

Type definitions have been included for TypeScript support.

Logo Attribution

Logo graphics by Twemoji, licensed under CC-BY 4.0. Favicon by favicon.io.

Contributing

Open source software is awesome and so are you. 😎

Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.

For major changes, open an issue first to discuss what you'd like to change.

See Kindling for npm script documentation.

⭐ Found It Helpful? Star It!

If you found this project helpful, let the community know by giving it a star: 👉⭐

MIT License

Copyright © 2020 Justin Mahar https://github.com/justinmahar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.