Skip to content

Commit

Permalink
Add docs to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Cypress Borg authored and cy-by committed Oct 10, 2023
1 parent 01983cd commit d1d4bdb
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1182,9 +1182,11 @@ The address fragment has two required parameters, `validate` and `inputName`.

- `validate` is a boolean value that determines whether the address should be validated by Smarty
- `inputName` is the name that will be associated with all of the above inputs by being used as a
prefix in their input's name. For example, if the `inputName` is `homeAddress` then the corresponding
inputs will be `homeAddressStreetAddress1`, `homeAddressStreetAddress2`, `homeAddressCity`, `homeAddressState`,
and `homeAddressZipCode`.
prefix in their input's name. For example, if the `inputName` is `homeAddress` then the
corresponding
inputs will
be `homeAddressStreetAddress1`, `homeAddressStreetAddress2`, `homeAddressCity`, `homeAddressState`,
and `homeAddressZipCode`.

The address fragment has five optional
parameters: `streetAddressHelpText`, `streetAddress2HelpText`, `cityHelpText`, `stateHelpText`
Expand All @@ -1195,7 +1197,8 @@ Please note that when using the address fragment you will need to create corresp
your
flow inputs class for each of the above-mentioned inputs created by the fragment. For example, if
your
address fragments input name is `mailingAddress`, then you will need to create the following fields in
address fragments input name is `mailingAddress`, then you will need to create the following fields
in
your flow inputs class:

```
Expand Down Expand Up @@ -2347,6 +2350,17 @@ form-flow:
path: 'name-of-file.yaml'
```

#### Design System

We are moving towards using a [custom theme](https://codeforamerica.github.io/uswds/dist/) of
the [US Web Design System(USWDS)](https://designsystem.digital.gov/). Enabling this
property will add another template location in Thymeleaf for USWDS templates to be consumed.

| Property | Default | Description |
|--------------------------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `form-flow.design-system.name` | none | Can use `cfa-uswds` to enable the new CfA USWDS design system assets and templates. Otherwise Honeycrisp assets and templates are used. |
|

#### File upload properties

| Property | Default | Description |
Expand Down

0 comments on commit d1d4bdb

Please sign in to comment.