CoCreate-render

A simple render component in vanilla javascript. Easily configured using HTML5 attributes and/or JavaScript API. Take it for a spin in our playground!

Docs & Demo

For a complete guide and working demo refer to the doumentation

CDN

<script src="https://cdn.CoCreateJS.com/render/latest/CoCreate-render.min.js"></script>

<script src="https://cdn.CoCreateJS.com/render/latest/CoCreate-render.min.css"></script>

NPM

$ npm i @cocreate/render

yarn

$ yarn install @cocreate/render

Table of Contents

• Table of Contents
• Announcements
• Roadmap
• How to Contribute
• About
• License

Announcements

All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email for releases and breaking changes.

Roadmap

If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.

About

CoCreate-render is guided and supported by the CoCreate Developer Experience Team.

Please Email the Developer Experience Team here in case of any queries.

CoCreate-render is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.

How to Contribute

We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.

We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create issues and pull requests or merely upvote or comment on existing issues or pull requests.

We appreciate your continued support, thank you!

License

This software is dual-licensed under the GNU Affero General Public License version 3 (AGPLv3) and a commercial license.

• Open Source Use: For open-source projects and non-commercial use, this software is available under the AGPLv3. The AGPLv3 allows you to freely use, modify, and distribute this software, provided that all modifications and derivative works are also licensed under the AGPLv3. For the full license text, see the LICENSE file.

• Commercial Use: For-profit companies and individuals intending to use this software for commercial purposes must obtain a commercial license. The commercial license is available when you sign up for an API key on our website. This license permits proprietary use and modification of the software without the copyleft requirements of the AGPLv3. It is ideal for integrating this software into proprietary commercial products and applications.

If you have not purchased a commercial license and intend to use this software for commercial purposes, you are required to sign up for an API key on our website.

Server

Render also provides a stateless server-side HTML renderer. Import it from @cocreate/render/server; the browser renderer remains available from @cocreate/render.

Server rendering

The HTML function processes HTML strings, resolves nested file and database-backed content, applies state and metadata, and protects recursive includes from circular references.

import { HTML } from '@cocreate/render/server';

const html = await HTML({
  file: {
    src: `<html><body><h1 array="posts" object="post-id" key="title"></h1></body></html>`,
    pathname: "/pages/dashboard.html",
    organization_id: "organization-id"
  },
  organization: { languages: ["en"] },
  urlObject: new URL("https://example.com/pages/dashboard.html"),
  lang: "en",
  theme: "dark",
  crud: crudInstance
});

Server HTML attributes

The server renderer evaluates src for nested file fragments, array and object to resolve records, and key to place a value. It also supports filter, value-type="outerHTML", render-error, state-id, and state-overwrite. Server rendering marks inserted content with rendered="true" so the browser does not fetch the same fragment again.