npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@knovator/masters-admin

v3.1.0

Published

Package for integrating Masters, Submasters functionality in React projects

Downloads

82

Readme

About The Project

@knovator/masters-admin is built with intent to faster web app development cycle by providing plug & play facility for masters/submasters, that is used almost on every project.

Built With

Getting Started

@knovator/masters-admin is designed to be used in ReactJS/NextJS project.

Prerequisites

Following packages are required to exists/installed to use @knovator/masters-admin in the project.

Installation

npm install @knovator/masters-admin
# or
yarn add @knovator/masters-admin

Usage

Provider

@knovator/masters-admin uses Context API, to support communication between components. So, Masters/Submaster should be wraped by Provider.

import { Provider } from '@knovator/masters-admin`;

function App() {
    return (
        <Provider
            ...
        >
            ...
        </Provider>
    )
}

Props

  • token
    • JWT token to be sent along the requests
  • baseUrl
    • Base API url, without forward slash at end i.e. https://api.xy000z.in
  • dataGetter (optional)
    • function to get docs from axios API response
    // default
    (response) => response.data.docs
  • paginationGetter (optional)
    • function to get pagination data from axios API response
    // default
    (response) => response.data
  • onError(callback_code, code, message) (optional)
    • callback to execute on error
  • onSuccess(callback_code, code, message) (optional)
    • callback to execute on success
  • onLogout (optional)
    • callback to execute on API request with unauthorized code in body

Master

Please check in masters.md

SubMaster

Plase check in submasters.md

ImageUpload

  • Provide Image Upload component to use in Forms

Props

  • className (optional) => string
  • text => string | JSX.Element to show inside component
  • maxSize => number Max size for image to upload
  • imgId => string | ImageObjectProps
  • setImgId => (value?: string | null) => void
  • clearError (optional) => () => void
  • onError => (msg: string) => void
  • onImageUpload => (file: File) => Promise<{ fileUrl: string; fileId: string } | void>
    • Gets called when user uploads file, it should return fileUrl and fileId
  • onImageRemove (optional) => (id: string) => Promise<void>
    • Gets called when user removes the image
  • baseUrl => string
    • Gets used when showing image
  • error (optional) => string

Usecases

@knovator/masters is combination of two packages @knovator/masters-admin and @knovator/masters-admin. It is designed plug and play masters module in your project. It is useful in following cases:

  • Your app needs master, submaster facility to build things like state with city, experiences with skills, categories with subcategories etc.
  • You want to let admin manage masters and submasters data from admin panel.
  • You want to show masters and submasters data somewhere in your app.

If you have any other usecase, please open an issue with tag usecase. We will try to add it in our roadmap.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Knovator Technologies

Project Link: https://github.com/knovator/masters-admin