Skip to content

Commit e044737

Browse files
📝 [#279] Update Storybook docs and README
1 parent 21d6c92 commit e044737

File tree

2 files changed

+26
-3
lines changed

2 files changed

+26
-3
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![Storybook](https://img.shields.io/badge/docs-Storybook-FF4785?style=flat)][Storybook]
55
[![Coverage](https://codecov.io/github/open-formulieren/formio-renderer/graph/badge.svg?token=446OCQXNUG)](https://codecov.io/github/open-formulieren/formio-renderer)
66
![Code formatting with Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)
7+
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=fff)](#)
8+
[![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=fff)](#)
79

810
The "renderer" is the React render engine used in Open Forms, responsible for displaying the form
911
fields for the user to fill out and capturing the input data.

src/0001-index.mdx

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,15 @@ import {Meta} from '@storybook/addon-docs/blocks';
66

77
`@open-formulieren/formio-renderer` is a pure React based renderer for Formio form definitions.
88

9+
[![NPM](https://img.shields.io/npm/v/@open-formulieren/formio-renderer.svg)](https://www.npmjs.com/package/@open-formulieren/formio-renderer)
10+
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=fff)](#)
11+
[![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=fff)](#)
12+
913
## Quickstart
1014

11-
**NOTE** - this library is still in active development and public API _may_ change.
15+
As of version 1.0, the public API is stable, and Semantic Versioning applies. The
16+
[changelog](https://github.com/open-formulieren/formio-renderer/blob/main/CHANGELOG.md) is on
17+
Github.
1218

1319
**High level API**
1420

@@ -121,7 +127,13 @@ Forms.
121127

122128
## Roadmap
123129

124-
See [Github](https://github.com/open-formulieren/open-forms/issues/5133)
130+
The port from Formio.js to our own implementation is complete, which was the scope for 1.0.
131+
132+
We now want to realize improvements that were not possible before, in particular:
133+
134+
- improve the `editgrid` component
135+
- improve the `addressNL` component
136+
- re-evaluate past deprecations and check if simplifications are possible
125137

126138
## Design goals
127139

@@ -165,9 +177,18 @@ The code base is structured so that:
165177
- we build on top of `@open-formulieren/types` so that we only worry about the features that Open
166178
Forms provides/supports.
167179

180+
## Developer mantras
181+
182+
- Your code must be readable for other developers. Double check with them to make sure.
183+
- Avoid pulling in unnecessary dependencies - check if native HTML features exist. If large
184+
dependencies are necessary, see if you can lazy-load them.
185+
- Similar code is not the same - sometimes repeating/duplicating code is the better approach.
186+
- Keep final bundle size in mind - use lazy-loading to facilate bundle splitting.
187+
- Dare to say "no" when something does not fit our design goals or design decisions.
188+
168189
## Design decisions
169190

170-
Decisions made while ipmlementing the renderer.
191+
Decisions made while implementing the renderer.
171192

172193
**Backend API interaction**
173194

0 commit comments

Comments
 (0)