evolutility-ui-react0.3.0 • Public • Published
Evolutility-UI-React is a set of model-driven views to Browse, Edit, List, Cards, and Charts data by writing models rather than code.
# To get the latest stable version, use git from the command line.git clone https://github.com/evoluteur/evolutility-ui-react
or use the npm package:
# To get the latest stable version, use npm from the command line.npm install evolutility-ui-react
In the Evolutility-UI-React directory, use the command line to type the following:
# Install dependenciesnpm install# Run the node.js servernpm start
In a web browser, go to the url http://localhost:3000/.
For the REST endpoints, you also need to install and run Evolutility-Server-Node which provides the matching REST endpoints based on the same metadata.
Configurations options are specified in the file /src/config.js. They apply to all apps (app specific options are specified in models).
|apiPath||Path to REST API (can use "proxy" from package.json).||"/api/v1/"|
|filesUrl||Path to upload files to.||"http://localhost:3000/pix/"|
|locale||Date format (no translation yet)||en/fr|
|wTimestamp||Add timestamp columns u_date and c_date to track record creation and update times.||true|
For any object, a single model defines UI elements across views in a simple declarative way.
Evolutility-UI-React provides 2 types of view:
Notes: Views for actions will come later.
A large part of the API (methods, options and events) is common to all views. Some views have additional API.
Views for One object
Shows all fields for viewing (read only). Fields are grouped in panels.
This view shows all fields for edition to create or update records. It automatically performs validation based on the model. Fields are grouped in panels and tabs.
Views for Many objects
Gives a tabular view of a collection.
Shows records side by side as cards.
Draws charts about the collection (currently bars and pies).
Display last update, number of updates in the last week, and for numeric fields the min, max, count, average.
Each model describe an object and its list of fields. A single model is used for all views (Browse, Edit, List, Cards...).
|id||Unique key to identify the entity (used as API parameter).|
|icon||Icon file name for the entity (example: "cube.gif").|
|name||Object name (singular).|
|namePlural||Object name (plural).|
|fields||Array of Fields.|
|groups||Array of Groups. If not provided a single group will be used.|
|collections||Array of Collections.|
|titleField||Field id for the column value used as record title. titleField can also be a function.|
|defaultViewOne||To have List and Cards link to Edit instead of Browse, set defaultViewOne="edit".|
Objects have fields.
|id||Unique key for the field (can be the same as column but doesn't have to be).|
|type||Field type to show in the UI. Possible field types:
|label||Field description (displayed with an asterisk for required fields).|
|labelShort||Optional shorter version of the labels (used in List and Cards views).|
|required||Determines if the field is required for saving.|
|readonly||If set to true, the field value cannot be changed.|
|defaultValue||Default field value for new records.|
|max, min||Maximum/Minimum value allowed (only applies to numeric fields).|
|maxLength, minLength||Maximum/Minimum length allowed (only applies to text fields).|
|lovIcon||Set to True to include icon with LOV items.|
|object||Model id for the object to link to (only for fields of "lov" type).|
|inMany||Determines if the field is present (by default) in lists of records.|
|height||For fields of type "textmultiline", number of lines used in the field (in Browse and Edit views).|
|width||Field width in Browse and Edit views (in percent of parent width).|
|help||Optional help on the field.|
|chartType||Default charts type used for the field ("Bars", "Pie", or "Table"). "Bars" is used if not specified.|
|noCharts||Prevent the field to have a charts (only necessary for fields of type integer, decimal, money, boolean, list of values which are "chartable").|
|unique||Values must be unique (not implemented yet).|
Groups are used to visually divide Fields (in Edit and Browse views).
|id||Unique key for the group. It is optional.|
|type||Type of fields group. Only "panel" is currently supported (tab and other types of groups will be added later).|
|label||Group title displayed in the group header.|
|fields||Array of field ids.|
|width||Width (in % of the container total width).|
|header||Text to be displayed at the top of the group (just below the group title).|
|footer||Text to be displayed at the bottom of the group.|
Note: Groups are optional. By default a single group holds all fields.
Multiple details tables can be specified with "collections".
|id||Unique key for the collection.|
|object||Model.id for the Object to link to.|
|fields||Array of fields (objects or ids). Fields in collections do not need all properties of Fields in objects.|
|header||Text to be displayed before the collection.|
|footer||Text to be displayed after the collection.|
Sample model using collections: Wine Cellar.
The following example is the model for a simple graphic novels inventory app.
moduleexports =id: "comics"label: "Graphic Novels"name: "graphic novel serie"namePlural: "graphic novel series"icon: "comics.png"titleField: "title"searchFields: "title" "authors" "notes"fields:id: "title" type: "text" label: "Title" required: truemaxLength: 255width: 100 inMany: trueid: "authors" type: "text" width: 62 inMany: truelabel: "Authors"id: "genre" type: "lov" label: "Genre"width: 38 inMany: truelist:id: 1 text: "Adventure"id: 2 text: "Fairy tale"id: 3 text: "Erotic"id: 4 text: "Fantastic"id: 5 text: "Heroic Fantasy"id: 6 text: "Historic"id: 7 text: "Humor"id: 8 text: "One of a kind"id: 9 text: "Youth"id: 10 text: "Thriller"id: 11 text: "Science-fiction"id: 12 text: "Super Heros"id: 13 text: "Western"id: "serie_nb" type: "integer"width: 15 inMany: falselabel: "Albums" noCharts: trueid: "have_nb" type: "integer"width: 15 inMany: falselabel: "Owned" noCharts: trueid: "have" type: "text"width: 15 inMany: falselabel: "Have"id: "language" type: "lov" label: "Language"width: 17 inMany: truelovIcon: truelist:id: 2 text: 'French' icon:'comics/flags/fr.png'id: 1 text: 'American' icon:'comics/flags/us.png'id: "complete" type: "boolean"width: 19 inMany: falselabel: "Complete"id: "finished" type: "boolean"width: 19 inMany: falselabel: "Finished"id: "pix" type: "image"width: 30 inMany: truelabel: "Cover"id: "notes" type: "textmultiline"label: "Notes" maxLength: 1000width: 70 height: 7 inMany: falsegroups:id:"serie" type: "panel" label: "Serie" width: 70fields: "title" "authors" "genre""serie_nb" "have_nb" "have""language" "complete" "finished" "notes"id:"pix" type: "panel" label: "Album Cover" width: 30fields: "pix"
Other implementations of Evolutility
Evolutility-UI-jQuery - Model-driven Web UI for CRUD using jQuery and Backbone (for REST or localStorage).
Evolutility-ASP.net - Lightweight CRUD framework for heavy lifting with ASP.net and Microsoft SQL-Server.
Copyright (c) 2019 Olivier Giulieri.
Evolutility-UI-React is released under the MIT license.
To suggest a feature or report a bug: https://github.com/evoluteur/evolutility-ui-react/issues