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

@frappy/react-content

v1.2.0

Published

React Components for Content Management and Data Handler

Downloads

3

Readme

React Content

Content Management, Display Components and API Handlers

Usage

You need to provide the model for your various types of content as configuration to the component. References are used to associate content with IDs for other domain objects that you want to assign stuff to:

import React from "react"
import { ContentManager } from "@frappy/react-content"

const SomeComponent = props => (
    <ContentManager
        references={["demo1", "demo2"]}
        contentTypes={{
            description: {
                list: false,
                fields: ["title", "description"],
            },
            team: {
                list: true,
                fields: ["name", "role"],
            },
            papers: {
                list: true,
                fields: ["title", "authors", "publication", "year"],
            },
        }}
    />
)

API Endpoints

The following assumes the default prefix /api/content. URL parameter are prefixed with :

  • GET /api/content - retrieves a list of all content objects
  • GET /api/content/:contentId - retrieves a specific content object

Content Management Endpoints

  • POST /api/content - creates a new content object with label, contentType, references and content in the body
  • POST /api/content/:contentId - updates content object with label, references and content in the body
  • DELETE /api/content/:contentId - deletes a content object

Content Handler

The package also provides an API handler class that allows to easily query content objects from the database:

import { ContentHandler } from "@frappy/react-content"

const handler = new ContentHandler()  // pass an optional argument, if you use a different API prefix on the backend
// get all
handler.getContentList().then(allContent => {
    // allContent is an array of all content objects
})  
// filter by reference
handler.getContentList("demo1").then(demo1Content => {
    // demo1Content is only content assigned to reference "demo1"
})
// filter by reference and content type
handler.getContentList("demo1", "team").then(demo1TeamContent => {
    // list of content of type "team" and associated to "demo1" (reference)
})
// just filter by content type
handler.getContentList(null, "team").then(teamContent => {
    // gives a list of "team" content types
})