SenseNet / sn-controls-react

React controls for sensenet

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sn-controls-react


This package is not under active development. You can find our latest packages in the sensenset/sn-client monorepo.


Greenkeeper badge Join the chat at https://gitter.im/SenseNet/sn-controls-react License Commitizen friendly

Collection of React components for sensenet ECM with Material-UI

Sense/Net Services

Usage and installation

You can install the latest version from NPM

npm install --save sn-controls-react

You can import fieldcontrol and viewcontrol components into your React App the conventional way.

import { NewView, EditView, CommandButtons } 'sn-controls-react';

...

View Controls

View Controls are almost the same as the .ascx Content Views in sensenet Webpages. This components define how the given Content will be rendered. As a Content is built up of Fields the View Control displays the Content using Field Controls to provide a surface to display/modify the Field values of the Content. View Control therefore depends on the Content Type of the specific Content.

Content creation form (NewView)

import { NewView } from 'sn-controls-react'
import createBrowserHistory from 'history/createBrowserHistory'
const history = createBrowserHistory()

// content: Content | required  | empty Content Object
// history: history Object made with createBrowserHistory() | optional | called after submit | default: window.history.back()
// onSubmit: Function | optional | called on submit event | default: window.history.back()

<NewView 
content={content} 
history={history} 
onSubmit={() => {})} />

Content editor form (EditView)

import { EditView } from 'sn-controls-react'
import createBrowserHistory from 'history/createBrowserHistory'
const history = createBrowserHistory()

// content: Content | required  | empty Content Object
// history: history Object made with createBrowserHistory() | optional | called after submit | default: window.history.back()
// onSubmit: Function | optional | called on submit event | default: window.history.back()

<EditView 
content={content} 
history={history} 
onSubmit={() => {})} />

Content browse view (BrowseView)

import { BrowseView } from 'sn-controls-react'

// content: Content | required  | empty Content Object

<BrowseView 
content={content} />

Field Controls

Just as legacy controls in sensenet Webpages Field Control components provide GUI for setting/modifying Field values of a Content but this time not as .ascx views but React Components.

About

React controls for sensenet

License:GNU General Public License v2.0


Languages

Language:TypeScript 99.0%Language:CSS 1.0%Language:JavaScript 0.0%