2023-10-29 17:20:35 +01:00
|
|
|
---
|
|
|
|
title: flag.note()
|
|
|
|
---
|
|
|
|
|
|
|
|
This flags information at the `note` level.
|
|
|
|
|
|
|
|
Info that is flagged is stored in the store under `plugins.plugin-annotations.flags.note`.
|
|
|
|
The core library does nothing with this info, it is merely stored, much like logs are.
|
|
|
|
|
|
|
|
However, in our own UI on FreeSewing.org, we use this mechanism to allow
|
|
|
|
designer to flag information to the user, and even suggest changes to the
|
|
|
|
pattern configuration.
|
|
|
|
|
|
|
|
## Signature
|
|
|
|
|
|
|
|
```js
|
|
|
|
undefined Store.flag.note({
|
|
|
|
title: 'Something good to know',
|
|
|
|
desc: 'Longer message here'
|
|
|
|
})
|
|
|
|
```
|
|
|
|
|
|
|
|
Since these methods are not part of FreeSewing's core API, what you pass to this method does depend on your own implementation.
|
|
|
|
|
2025-05-22 10:20:18 -07:00
|
|
|
:::note RELATED
|
|
|
|
The above Signature contains abbreviated information.
|
|
|
|
For full details about this method's Signature, Configuration, and
|
|
|
|
Example usage, see [flag.info()](/reference/store-methods/flag.info).
|
|
|
|
:::
|