==============
Open Forms SDK
==============

:Version: 3.5.1
:Source: https://github.com/open-formulieren/open-forms-sdk
:Keywords: e-Formulieren, Common Ground, FormIO, API

|docs|

Easily integrate forms from Open Forms in your own website
(`Nederlandse versie`_)

Developed by `Maykin Media B.V.`_, commissioned by `Dimpact`_.


Introduction
============

The Open Forms Javascript SDK (source development kit) enables users to embed,
render and submit forms that are defined in `Open Forms`_. The SDK leverages
the Open Forms API, and is built on top of the `formio.js`_ SDK.

A default style is included but rendered form elements can be styled in line
with your own website.

Open Forms is developed in line with the `Common Ground`_ principles,
with many plugins for government usage and with a strong focus on usability for
both end users and administrators.

.. _`formio.js`: https://github.com/formio/formio.js/
.. _`Common Ground`: https://commonground.nl/
.. _`Open Forms`: https://github.com/open-formulieren/open-forms/


Component
=========

|build-status| |coverage| |storybook| |prettier|

This component is a Javascript SDK.


References
==========

* `Documentation <https://open-forms.readthedocs.io/>`_
* `Community <https://commonground.nl/groups/view/0c79b387-4567-4522-bc35-7d3583978c9f/open-forms>`_
* `Issues <https://github.com/open-formulieren/open-forms-sdk/issues>`_
* `Code <https://github.com/open-formulieren/open-forms-sdk>`_
* `Open Forms component <https://github.com/open-formulieren/open-forms>`_

Licence
=======

Copyright © `Dimpact`_, 2021

Licensed under the `EUPL`_.

.. _`Nederlandse versie`: README.NL.rst
.. _`Maykin Media B.V.`: https://www.maykinmedia.nl
.. _`Dimpact`: https://www.dimpact.nl
.. _`EUPL`: LICENSE.md

.. |build-status| image:: https://github.com/open-formulieren/open-forms-sdk/actions/workflows/ci.yml/badge.svg
    :alt: Build status
    :target: https://github.com/open-formulieren/open-forms-sdk/actions/workflows/ci.yml

.. |docs| image:: https://readthedocs.org/projects/open-forms/badge/?version=latest
    :target: https://open-forms.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation status

.. |coverage| image:: https://codecov.io/github/open-formulieren/open-forms-sdk/branch/main/graphs/badge.svg?branch=main
    :alt: Coverage
    :target: https://codecov.io/gh/open-formulieren/open-forms-sdk

.. |storybook| image:: https://img.shields.io/badge/docs-Storybook-FF4785?style=flat
    :alt: Storybook
    :target: https://open-formulieren.github.io/open-forms-sdk/

.. |prettier| image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
    :alt: Code formatting with Prettier
    :target: https://github.com/prettier/prettier
