Skip to content

Commit 4060d0d

Browse files
committed
doc: fix documentation to refer to options not `config.
1 parent e76c49b commit 4060d0d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ The component supports the `v-model` attribute.
3838

3939
The textual content of the element is used as the initial value of the editor.
4040

41-
The mathfield can be configured using the `:config` attribute, for example to
41+
The mathfield can be configured using the `:options` attribute, for example to
4242
specify the location of the fonts directory. Read more about the [available options](http://cortexjs.io/docs/mathlive/?q=MathfieldConfig).
4343

4444
```html
4545
<mathlive-mathfield
46-
:config="{smartFence:false}"
46+
:options="{smartFence:false}"
4747
@focus="ping"
4848
:on-keystroke="displayKeystroke"
4949
v-model="formula"
@@ -57,7 +57,7 @@ specify the location of the fonts directory. Read more about the [available opti
5757
| Name | Type | Description |
5858
| ------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5959
| `value` | `string` | The content of the matfield, represented as a LaTeX string. |
60-
| `config` | `object` | Configuration options for the mathfield. See [documentation](http://cortexjs.io/docs/mathlive/?q=MathfieldConfig) |
60+
| `options` | `object` | Configuration options for the mathfield. See [documentation](http://cortexjs.io/docs/mathlive/?q=MathfieldConfig) |
6161
| `onKeystroke` | `(keystroke:string, ev:Event) => boolean` | A callback invoked when a key is pressed. `keystroke` is a string describing the keystroke, `ev` is the native keyboard event. Return false to stop handling of the event |
6262
| `onMoveOutOf` | `(string) => boolean` | A callback invoked when keyboard navigation would cause the insertion point to leave the mathfield. The argument indicates the direction of the navigation, either "forward" or "backward". Return false to prevent the move, true to wrap around to the start of the field. By default, the insertion point will wrap around. |
6363
| `onTabOutOf` | `(string) => boolean` | A callback invoked when pressing tab (or shift-tab) would cause the insertion point to leave the mathfield. The argument indicates the direction of the navigation, either "forward" or "backward". Return false to prevent the move, true to wrap around to the start of the field. By default, the insertion point will wrap around. |

0 commit comments

Comments
 (0)