Git Product home page Git Product logo

cms-client's Introduction

cms-client

Visually edit your react components with end-to-end type safe schemas.

Installation

pnpm add cms-client-dane

npm i cms-client-dane

yarn add cms-client-dane

Usage

Build a component

import { z } from "zod";

export default function Button({ children }: ButtonProps) {
  return <button type="button">{children}</button>;
}

export type ButtonProps = z.infer<typeof ButtonProps>;
export const ButtonProps = z.object({
  children: z.string().default("Click me!"),
});

Define your CMS

import { C, loadable } from "cms-client-dane";

export const cms = new C();

// Link your component
cms.define(
  loadable(() => import(`~/components/Button`)),
  {
    name: "Button",
    icon: `mdi:button`,
    schema: ButtonProps,
  }
);

Render a page with remix.run

import { json, LoaderArgs } from "@remix-run/node";
import Button from "~/components/Button";
import { Page } from "cms-client-dane";

export const loader = async ({ request }: LoaderArgs) => {
  const pageData = await cms.getPageData(request);
  return json({ pageData });
};

export default function Index() {
  const { pageData } = useLoaderData<typeof loader>();
  return <Page data={pageData} />;
}

cms-client's People

Contributors

dane-stevens avatar github-actions[bot] avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.