Nanobots Protecting Microbots
    Wondering what’s next for npm?Check out our public roadmap! »

    evolutility-ui-react

    0.4.0 • Public • Published

    Evolutility-UI-React · GitHub license npm version

    Evolutility-UI-React is a set of model-driven views to Browse, Edit, List, Cards, and Charts data. With it you can build applications by writing models rather than code.

    Edit

    Table of Contents

    1. Installation
    2. Configuration
    3. Views: One - Many - Doc
    4. Models
    5. Backend
    6. License

    Installation

    Download or clone from GitHub.

    # 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 dependencies
    npm install
    
    # Run the node.js server
    npm 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.

    Configuration

    Configurations options are specified in the file /src/config.js. They apply to all apps (app specific options are specified in models).

    Option Description Example
    apiPath Path to REST API (can use "proxy" from package.json). "http://localhost:2000/api/v1/"
    filesUrl Path to upload files to. "http://localhost:3000/pix/"
    pageSize Page size in pagination. 50
    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

    Views

    For any object, a single model defines UI elements across views in a simple declarative way.

    Evolutility-UI-React provides different types of view:

    Notes: Views for actions (search, filter, export) will come later.

    A large part of the API (methods, options and events) is similar in all views. Some views have additional endpoints. For convenience, there is an API documentation view to document and test the API.

    Views for One object

    Browse - Edit

    Browse

    Shows all fields for viewing (read only). Fields are grouped in panels.

    Browse

    Code: /src/components/views/one/Browse.js

    View: http://localhost:3000/comics/browse/{id}

    Edit

    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.

    Edit

    Code: /src/components/views/one/Edit.js

    View: http://localhost:3000/comics/edit/{id}

    Views for Many objects

    List - Cards - Charts - Stats

    List

    Gives a tabular view of a collection.

    List

    Code: /src/components/views/many/List.js

    View: http://localhost:3000/comics/list

    Cards

    Shows records side by side as cards.

    Cards

    Code: /src/components/views/many/Cards.js

    View: http://localhost:3000/comics/cards

    Charts

    Draws charts about the collection. Currently bars and pie charts are implemented, a list with count and percentages is also available. Only provided for fields of types like boolean, lov, integer, decimal, date... (not text or textmultilines).

    Charts

    Code: /src/components/views/charts/Charts.js

    View: http://localhost:3000/comics/charts

    Stats

    Display last update, number of updates in the last week, and for numeric fields the min, max, count, average.

    Stats

    Code: /src/components/views/many/Stats.js

    View: http://localhost:3000/comics/stats

    Views for Documentation

    REST API

    Documentation and test for the model's REST endpoints.

    API

    Code: /src/components/views/doc/Api.js

    View: http://localhost:3000/comics/api

    Models

    Each model describe an object and its list of fields. A single model is used for all views (Browse, Edit, List, Cards...).

    For any object, all UI views (List, Cards, Edit, Charts...) share the same model. All Fields are present in the Edit and Browse views. Fields can be flagged with "inMany" to be included in the List and Cards views, or "noCharts" and "noStats" to be excluded from the Charts or Stats views.

    Object

    Property Meaning
    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).
    title Application name.
    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".

    Field

    Objects have fields.

    Property Meaning
    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:
    • boolean (yes/no)
    • date
    • datetime
    • decimal
    • document
    • email
    • image
    • integer
    • json
    • lov (list of values)
    • list (multiselect)
    • money
    • text
    • textmultiline
    • time
    • url
    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 Exclude field from charts (only applies to fields of type integer, decimal, money, boolean, list of values which are "chartable").
    noStats Exclude field from Stats.
    unique Requires value to be unique (not implemented yet).

    Group

    Groups are used to separate Fields into panels in the Edit and Browse views.

    Property Meaning
    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.

    Notes:

    • Groups are optional. By default a single group holds all fields.
    • Groups are positioned based on their "width" property the same way than fields are positioned inside groups.

    Collection

    Multiple details tables can be specified with "collections".

    Property Meaning
    id Unique key for the collection.
    title Collection title.
    object Model.id for the Object to link to.
    fields Array of fields (objects or ids). Fields in collections can be field objects or just ids of fields in the collection's object.
    header Text to be displayed before the collection.
    footer Text to be displayed after the collection.

    Sample model using collections: Wine Cellar.

    Sample model

    The following example is the model for a simple graphic novels inventory app.

    module.exports = {
        id: "comics",
        label: "Graphic Novels",
        name: "graphic novel serie",
        namePlural: "graphic novel series",
        icon: "comics.png",
        titleField: "title",
        fields:[
          {
              id: "title", type: "text", 
              label: "Title", 
              required: true, maxLength: 255,
              width: 100, inMany: true, 
          },
          {
              id: "authors", type: "text", 
              label: "Authors",
              inMany: true, width: 62, 
              
          },
          {
              id: "genre", type: "lov", 
              label: "Genre", 
              width: 38, inMany: true,
              list: [
                {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",
              label: "Albums", noCharts: true, 
              width: 15, inMany: false 
          },
          {
              id: "have_nb", type: "integer",
              label: "Owned", 
              width: 15, inMany: false, noCharts: true
          },
          {
              id: "have", type: "text",
              label: "Have", 
              width: 15, inMany: false
          },
          {
              id: "language", type: "lov", 
              label: "Language", 
              width: 17, inMany: true,
              lovIcon: true,
              list: [
                {id: 2, text: 'French', icon:'comics/flags/fr.png'},
                {id: 1, text: 'American', icon:'comics/flags/us.png'}
              ]
          },
          {
              id: "complete", type: "boolean",
              label: "Complete", 
              width: 19, inMany: false
          },
          {
              id: "finished", type: "boolean",
              label: "Finished", 
              width: 19, inMany: false
          },
          {
              id: "pix", type: "image",
              label: "Cover", 
              width: 30, inMany: true
          },
          {
              id: "notes", type: "textmultiline", 
              label: "Notes", 
              width: 70, height: 7, maxLength: 5000,
              inMany: false
          }
      ],
    
      groups: [
          { 
            id:"serie", type: "panel", label: "Serie", width: 70,
            fields: ["title", "authors", "genre", 
                  "serie_nb", "have_nb", "have", 
                  "language", "complete", "finished", "notes"
            ]
          },
          { 
            id:"pix", type: "panel", label: "Cover", width: 30,
            fields: ["pix"]
          }
      ]
    }

    More sample models: To-do list, Address book, Restaurants list, Wine cellar.

    Evolutility backend

    Evolutility-Server-Node provides REST or GraphQL end-points for Evolutility-UI-React using the same models.

    Earlier implementations for other stacks

    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.

    License

    Copyright (c) 2020 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

    Install

    npm i evolutility-ui-react

    DownloadsWeekly Downloads

    9

    Version

    0.4.0

    License

    MIT

    Unpacked Size

    1.6 MB

    Total Files

    224

    Last publish

    Collaborators

    • avatar