chore(markdown): Restructuring dev docs
This commit is contained in:
parent
9ef46c502a
commit
d42d9a9377
114 changed files with 246 additions and 1462 deletions
17
markdown/dev/reference/api/hooks/en.md
Normal file
17
markdown/dev/reference/api/hooks/en.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: Hooks API
|
||||
for: developers
|
||||
about: Documents the available lifecycle hooks in Core and how to use them
|
||||
---
|
||||
|
||||
A **hook** is a lifecycle event.
|
||||
|
||||
You can register a method for a hook. When the hook is triggered, your method will be
|
||||
called. It will receive two parameters:
|
||||
|
||||
- An object relevant to the hook (see the specific hook for details)
|
||||
- Data passed when the hook was registered (optional)
|
||||
|
||||
Below is a list of all available hooks:
|
||||
|
||||
<ReadMore list />
|
47
markdown/dev/reference/api/hooks/inserttext/en.md
Normal file
47
markdown/dev/reference/api/hooks/inserttext/en.md
Normal file
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: insertText
|
||||
---
|
||||
|
||||
The `insertText` hook is called when text is about to be inserted during rendering.
|
||||
|
||||
Methods attached to the `insertText` hook will receive 2 parameters:
|
||||
|
||||
- `locale` : The language code of the language requested by the user (defaults to `en`)
|
||||
- `text`: The text to be inserted
|
||||
|
||||
Unlike most hooks that receive an object that you can make changes to,
|
||||
for this hook you need to return a string.
|
||||
|
||||
This hook is typically used for translation, as is the case
|
||||
in [our i18n plugin](/reference/plugins/i18n/).
|
||||
|
||||
## Understanding the insertText hook
|
||||
|
||||
When we say that *this hook is called when text is about to be inserted*, that is a simplified view.
|
||||
In reality, this hook is called:
|
||||
|
||||
- For every value set on data-text
|
||||
- For the combined result of these values, joined together with spaces
|
||||
|
||||
Let's use an example to clarify things:
|
||||
|
||||
```js
|
||||
points.example
|
||||
.attr('data-text', "seamAllowance")
|
||||
.attr('data-text', ": 1cm")
|
||||
```
|
||||
|
||||
For the example point above, the `insertText` hook will end up being called 3 times:
|
||||
|
||||
- First it will pass `seamAllowance` to the plugin
|
||||
- Then it will pass `: 1cm` to the plugin
|
||||
- Finally it will pass `seamAllowance : 1cm` to the plugin
|
||||
|
||||
Having the `insertText` hook only run once with `Seam allowance: 1cm` would be problematic because
|
||||
the seam allowance may differ, or perhaps we're using imperial units, and so on.
|
||||
|
||||
Instead, you can (and should) divide your text into chunks that need translating, and chunks that do not.
|
||||
|
||||
This is also why we're not inserting **Seam allowance** but rather **seamAllowance**;
|
||||
It is merely a key to indicate what translation we want to replace this text with.
|
||||
|
13
markdown/dev/reference/api/hooks/postdraft/en.md
Normal file
13
markdown/dev/reference/api/hooks/postdraft/en.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: postDraft
|
||||
---
|
||||
|
||||
The `postDraft` hook runs just after your pattern is drafted.
|
||||
|
||||
Your plugin will receive the Pattern object.
|
||||
|
||||
<Note>
|
||||
|
||||
The `postDraft` hook is rarely used.
|
||||
|
||||
</Note>
|
14
markdown/dev/reference/api/hooks/postrender/en.md
Normal file
14
markdown/dev/reference/api/hooks/postrender/en.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: postRender
|
||||
---
|
||||
|
||||
The `postRender` hook is triggered after the SVG is rendered.
|
||||
|
||||
Like the `preRender` hook, it receives [the SVG object](/api/svg) as its first parameter.
|
||||
|
||||
<Note>
|
||||
|
||||
The `postRender` hooks is rarely used.
|
||||
|
||||
</Note>
|
||||
|
19
markdown/dev/reference/api/hooks/postsample/en.md
Normal file
19
markdown/dev/reference/api/hooks/postsample/en.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
title: postSample
|
||||
---
|
||||
|
||||
The `postSample` hook runs just after your pattern is sampled.
|
||||
Your plugin will receive the Pattern object.
|
||||
|
||||
It is triggered just before the end of either:
|
||||
|
||||
- the [Pattern.sampleOption()](/reference/api/pattern/#sampleoption) method
|
||||
- the [Pattern.sampleMeasurement()](/reference/api/pattern/#samplemeasurement) method
|
||||
- the [Pattern.sampleModels()](/reference/api/pattern/#samplemodels) method
|
||||
|
||||
<Note>
|
||||
|
||||
The `postSample` hook is rarely used.
|
||||
|
||||
</Note>
|
||||
|
13
markdown/dev/reference/api/hooks/predraft/en.md
Normal file
13
markdown/dev/reference/api/hooks/predraft/en.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: preDraft
|
||||
---
|
||||
|
||||
The `preDraft` hook runs just before your pattern is drafted.
|
||||
|
||||
Your plugin will receive the Pattern object.
|
||||
|
||||
<Note>
|
||||
|
||||
The `preDraft` hook is rarely used.
|
||||
|
||||
</Note>
|
9
markdown/dev/reference/api/hooks/prerender/en.md
Normal file
9
markdown/dev/reference/api/hooks/prerender/en.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: preRender
|
||||
---
|
||||
|
||||
The `preRender` hook is triggered just before your pattern is rendered to SVG.
|
||||
|
||||
Your hook method will receive [the SVG object](/api/svg) as its first parameter.
|
||||
|
||||
It is typically used to change the result of the render, for example by adding CSS to the SVG output.
|
19
markdown/dev/reference/api/hooks/presample/en.md
Normal file
19
markdown/dev/reference/api/hooks/presample/en.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
title: preSample
|
||||
---
|
||||
|
||||
The `preSample` hook runs just before your pattern is sampled.
|
||||
|
||||
It is triggered at the very start of either:
|
||||
|
||||
- the [Pattern.sampleOption()](/reference/api/pattern/#sampleoption) method
|
||||
- the [Pattern.sampleMeasurement()](/reference/api/pattern/#samplemeasurement) method
|
||||
- the [Pattern.sampleModels()](/reference/api/pattern/#samplemodels) method
|
||||
|
||||
Your plugin will receive the Pattern object.
|
||||
|
||||
<Note>
|
||||
|
||||
The `preSample` hook is rarely used.
|
||||
|
||||
</Note>
|
Loading…
Add table
Add a link
Reference in a new issue