jmix-framework / jmix-docs Goto Github PK

View Code? Open in Web Editor NEW

16.0 13.0 34.0 411.22 MB

Documentation for Jmix framework

Home Page: https://www.jmix.io

License: Creative Commons Attribution 4.0 International

Java 95.87% Handlebars 0.53% CSS 0.53% SCSS 0.05% HTML 1.79% Groovy 0.26% JavaScript 0.53% TypeScript 0.44%

jmix

jmix-docs's Introduction

Jmix Documentation

This repository contains documentation for all Jmix framework modules. The documentation is published at https://docs.jmix.io.

Building

Install Node LTS release from https://nodejs.org
Open terminal in jmix-docs root folder and run:
```
npm i
npx antora antora-playbook.yml
```
Open jmix-docs/build/site/index.html in a web browser.

jmix-docs's People

Contributors

Stargazers

Watchers

jmix-docs's Issues

Document the PopupView component

Document TagField component

Description

See Haulmont/jmix-ui#167

Actualize and fix code example in Creating Calculated Attribute

Enviroment:

Part of the documentation: quick start
Existing page: https://docs.jmix.io/jmix/0.x/quick-start/index.html

Description of the bug or enchacement

§Creating Calculated Attribute

Different name of function in text and in example of code:
Text:
To do this, we need to create a new method - getFullName() in the Speaker class and make its return type String.

Code:

@InstanceName
@DependsOnProperties({"firstName", "lastName", "username"})
public String getDisplayName() {
    return String.format("%s %s [%s]", (firstName != null ? firstName : ""),
            (lastName != null ? lastName : ""), username);
}

AR: different names of function
ER: function should have one name in text and in example

There is no field 'username" in class Speaker which used in this function (p.1)
Listing of class (getters, setters and imports are omitted):

package com.company.jmixpr.entity;
@JmixEntity
@Table(name = "JMIXPR_SPEAKER")
@Entity(name = "jmixpr_Speaker")
public class Speaker {
    @JmixGeneratedValue
    @Column(name = "ID", nullable = false)
    @Id
    private UUID id;

    @Column(name = "FIRST_NAME", nullable = false)
    @NotNull
    private String firstName;

    @Column(name = "LAST_NAME")
    private String lastName;

    @Email
    @Column(name = "EMAIL", nullable = false, length = 1024)
    @NotNull
    private String email;
}

AR: non-existing field in function
ER: function should use only existing fields

Document the DatePicker component

Document the Label component

Add counter in the docs

We need to add a code on all the pages of documentation for statistics collection. The code is the following:

<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-MH3DTWV');</script>
<!-- End Google Tag Manager -->

Update Screen events description

Copied from cuba-platform/cuba#2947

We get feedback from some users that they don't understand what event they should listen to if they want to perform some screen initialization based on loaded data (collection containers, or edited entity graph in entity editor).

e.g.
https://www.cuba-platform.com/discuss/t/for-looping-through-child-entity-to-set-edit-ability-of-screen-components/8237/2
or
https://www.cuba-platform.com/discuss/t/geteditedentity-in-edit-screen/12785

In topics above users tried to use InitEvent.
But for most users the most "safe" event to use when you need a fully initialized screen - is "BeforeShow" (until you read the JavaDocs).

Because "BeforeShow" intuitively feels like "after all initialization is fully completed, right before showing the screen in the UI (attaching it to the main layout)".
Unfortunately BeforeShow event doesn't work this way. It is fired somewhere in the middle of the screen initialization process:

Event sent right before the screen is shown, i.e. it is not added to the application UI yet. ... Saved component settings are not yet applied to UI components. Data is not loaded yet for screens annotated with @LoadDataBeforeShow.

Contradictory description, isn't it? How it can be "right before" while settings weren't applied yet, and data wasn't loaded yet?

The proper event at the moment is the AfterShowEvent. However for some users it may feel intuitively wrong, because they tend to think that "UI is going to blink if I change something after the screen is shown". It is a false concern, but people have this feeling.

Seems that we need to update the Screen.BeforeShowEvent and Screen.AfterShowEvent description so that users will understand what event to use in what case.

Description

See Haulmont/jmix-ui#179

Enviroment:

Part of the documentation: quick start
Existing page: https://docs.jmix.io/jmix/0.x/quick-start/index.html

Description of the bug or enchacement

§Creating Data Model

There is too many symbols for field 'email' in example:

AR: length of field is 1024
ER: length of field should be equal or less than 256 symbols

jmix-framework / jmix-docs Goto Github PK

jmix-docs's Introduction

Jmix Documentation

Building

jmix-docs's People

Contributors

Stargazers

Watchers

Forkers

jmix-docs's Issues

Description

Enviroment:

Description of the bug or enchacement

Description

Enviroment:

Description of the bug or enchacement

Recommend Projects

Recommend Topics

Recommend Org