npmpackage.info

Gathering detailed insights and metrics for @luomus/laji-form

Other packages similar to @luomus/laji-form

laji-form

14.3.6

React module capable of building dynamic forms from Laji form json schemas

@luomus/laji-form-builder

1.1.8

UI for building laji.fi forms

@luomus/laji-form

JSON Schema form rendering library

15.1.33

MIT

JavaScript

3.59 MB

4,017 3.2

Installations

npm install @luomus/laji-form

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.20.2

NPM Version

8.19.4 Score

49.9

Supply Chain

63.6

Quality

91.8

Maintenance

100

Vulnerability

84.7

License

Pull Requests

Open

0

Total

18

Closed

0

Merged

18

Issues

Open

0

Total

1

Closed

1

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 7 Contributors

Languages

JavaScript

TypeScript

CSS

Shell

HTML

Dockerfile

JavaScript (59.56%)

TypeScript (35.66%)

CSS (4.5%)

Shell (0.22%)

HTML (0.04%)

Dockerfile (0.02%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

luomus

Download Statistics

Total Downloads

4,017

Last Day

Last Week

Last Month

299

Last Year

2,518

GitHub Statistics

MIT License

4,246 Commits

5 Watchers

8 Branches

7 Contributors

Updated on Feb 14, 2025

Maintainers

Package Meta Information

Latest Version

15.1.33

Package Id

@luomus/laji-form@15.1.33

Unpacked Size

3.59 MB

Size

904.23 kB

File Count

251

NPM Version

8.19.4

Node Version

16.20.2

Published on

Feb 14, 2025

Total Downloads

Cumulative downloads

Total Downloads

4,017

Last Day

-33.3%

Compared to previous day

Last Week

-73.2%

Compared to previous week

Last Month

64.3%

299

Compared to previous month

Last Year

68%

2,518

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Optional Dependencies

@fortawesome/fontawesome-svg-core @fortawesome/free-solid-svg-icons @fortawesome/react-fontawesome @types/react-bootstrap react-bootstrap react-bootstrap-5

README

LajiForm is a dynamic form built on React. It can be used as a standalone library or as a React component. LajiForm is a wrapper for react-jsonschema-form.

Installing

npm install @luomus/laji-form --save

If you are going to use the bootstrap 3 theme, you need to install also react-bootstrap:

npm install react-bootstrap@0.33.1 --save

Usage as a library

LajiForm passes all its properties to react-jsonschema-form. Read the documentation for react-jsonschema-form.

Usage as a standalone library

import LajiForm from "laji-form";

new LajiForm({
  schema: schema,
  uiSchema: uiSchema, formData: formData,
  rootElem: document.getElementById("app")
});

You can update the properties with setState(props). You need to pass only the properties that you are changing, since it just calls the React component's setState(props).

You can unmount the component with unmount().

Usage as a React component

import React from "react";
import { render } from "react-dom";
import LajiForm from "laji-form/lib/components/LajiForm";

render(<LajiForm
    schema={...}
    uiSchema={...}
    formData={...} />,
  document.getElementById("app"));

API Client

In addition to properties you would pass to <Form />, you must pass an api client implementation, if you need to use fields that use lajitest.api.fi. The api client implementation must have fetch() -method, which returns a Promise.

fetch(path, query, options) parameters are as follows:

path: URL path for GET.
query: Object, where keys are param names and values are param values.
options: Object containing options for request.

See the example implementation in src/playground/ApiClientImplementation.js.

Pass the implementation to LajiForm like so:

<LajiForm apiClient={new ApiClientImplementation()} ... />

Themes

Bootstrap 3

LajiForm provides bootstrap 3 theme. To use it, you need to install react-bootstrap@0.33.1 and provide the built-in bootstrap 3 theme it as a prop:

import bs3 from "laji-form/lib/themes/bs3";

<LajiForm theme={bs3} ... />

Bootstrap 5

To use bootstrap 5 theme, you need to install following packages:

npm install --save react-bootstrap-5@npm:react-bootstrap@2.5.0
mpn install --save @fortawesome/fontawesome-svg-core@6.2.0
npm install --save @fortawesome/free-solid-svg-icons@6.2.0
npm install --save @fortawesome/react-fontawesome@0.2.0

Then it can be used by providing the theme to the form:

import bs5 from "laji-form/lib/themes/bs5";

<LajiForm theme={bs5} ... />

You can also use a custom theme and provide it the same way. There is a theme interface themes/theme.ts which the theme must implement.

Notifications

LajiForm expects a notification implementation as a paratemer notifier. The notifier object must implement the interface below:

{
	success: message => (),
	warning: message => (),
	info: message => (),
	error: message => (),
}

Styles

Styles can be found at dist/styles.css.

Development

Run npm ci to install the dependencies and npm start to start the app.

Before running, you'll need to configure your personal apitest.laji.fi access token. Get the key to your email:

curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" -d "{\
  \"email\": \"<YOUR EMAIL ADDRESS>\"\
  }" "http://apitest.laji.fi/v0/api-token"

Copy settings template file:

cp properties.json.example properties.json

Then put the API access token you got in your email to properties.json. Put also your user access token & user ID there. Google API key is needed only for using the reverse geo location for foreign locations.

Try to keep the code style consistent - npm run lint should pass without errors.

Developing different forms

Start the server and navigate to the local playground http://localhost:8083?id={form_id}

Playground query parameters

Option	Default	Description
id	-	Form id to use. If empty, `playground/schemas.json` will be used for form schemas.
local	`false`	Use local schemas under `forms/` instead of fetching from apitest.laji.fi.
localFormData	`false`	Use local formData under `forms/${id}.formData.json` instead of form's `prepopulatedDocument`.
settings	`true`	Use local settings defined in `playground/schemas`.
lang	`fi`	Language of the form. Doesn't affect local forms.
readonly	`false`	Sets the form readonly.

Examples

http://localhost:8083?id=JX.519 Trip report form with empty formData.

http://localhost:8083?id=MHL.1&localFormData=true Line transect form with local formData.

Tests

You might need to install playwright dependencies to run the tests:

npx playwright install

The playground server can be running or or not. If it's not running, it will be automatically started.

Run the tests:

npm test

If you run into issues with browser dependencies etc, there's also a dockerized runner:

# Run all tests (builds docker image & runs it)
npm run test:docker

# Or if you want to give playwright params, run certain tests etc:
npm run test:docker -- test/mobile-form.spec.ts --project chromium

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.2

/10

Last Scanned on 2025-02-17

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More