Skip to content

[V4] Update documentation #938

Description

@rvsia

Scope: Docs

Description

Update documentation:

  • form state manager details
    • form props
    • form state
    • field props
    • field state
  • new imports esm/cjs
    • toggle in code examples
  • required css loaders for
    • ant
    • PF4
  • remove links to react-final-form
  • migration guide v2 > v3

Activity

  1. added
    docsdocs pull requests
    State managerForm state manager packages. Will be used a state management package for the form renderer.
    on Jan 18, 2021
  2. added and removed on Mar 1, 2021
  3. changed the title [-][V3] Update documentation[/-] [+][V4] Update documentation[/+] on Mar 1, 2021
  4. zgover commented on Jun 9, 2021

    @zgover
    Member

    @rvsia Please also add documentation for api usage of manual validation. It would be great to use the schema to validate posted field values on server side without rendering.

  5. Hyperkid123 commented on Jun 9, 2021

    @Hyperkid123
    Member

    @zgover can you provide a simple example?

  6. zgover commented on Jun 9, 2021

    @zgover
    Member

    @Hyperkid123 Say form values were posted to an API /api/endpoint?schemaId=123&email=name@domain.com&...

    While processing the request to verify the parameters/values were valid using a defined schema

    const schema = {
      fields: [
        { name: email, validate: [{type: 'required'}, {type: 'pattern', pattern: '^...$', message: 'Invalid email' }]
      }
    }
    
    function handler(req, res) {
      const { query: { schemaId, ...fieldValues } }  = req
      const invalidFields = validateFields(schema, fieldsValues)
      if (invalidFields.length > 0) {
        return res.status(400).json({ status: 'error', error: { field_errors: invalidFields, ... } })
      }
      res.status(200).json({ status: 'success', code: 200 })
    }
  7. Hyperkid123 commented on Jun 9, 2021

    @Hyperkid123
    Member

    Ah, I see. There should be similar functionality on the submit event. This would basically fall into the global validation category but instead of evaluating it client-side function, we would wait for a Promise response.

  8. rvsia commented on Jun 9, 2021

    @rvsia
    ContributorAuthor

    @zgover So, you want to have a separate "validation engine" based on the DDF schema to use outside the form renderer, right? This sounds like an interesting idea! 🤔

  9. zgover commented on Jun 9, 2021

    @zgover
    Member

    Maybe something available before v4? Should be easy to implement without breaking changes.

  10. rvsia commented on Jun 9, 2021

    @rvsia
    ContributorAuthor

    @zgover Yeah, I will take a look on it today. And it would be a definitely just an addition, so we can release it asap.

  11. Hyperkid123 commented on Jun 9, 2021

    @Hyperkid123
    Member

    The validation engine is available even now. It's just not prepared to "consume" schema but only a field state.

  12. rvsia commented on Jun 10, 2021

    @rvsia
    ContributorAuthor

    @zgover Hello, the standalone validation has been released, you can check it here: https://data-driven-forms.org/utilities/standalone-validation

  13. zgover commented on Jun 10, 2021

    @zgover
    Member

    Much appreciate the quickness @rvsia and @Hyperkid123

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    State managerForm state manager packages. Will be used a state management package for the form renderer.docsdocs pull requestsv4

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions