1
0
Fork 0
freesewing/sites/dev/docs/reference/api/snippet/attr
Benjamin Fan ed8a166ea9 fix(reference:api): Revert incorrect Example formatting (#367)
This PR reverts the incorrect lint/prettier changes applied to <Example> code in the reference Core API docs l by the husky pre-commit hook, the problem mentioned in Issue #333.

(These are just the changes for the Core API docs. Additional PRs will be filed for changes in the other reference, howtos, and guides documentation.)

Co-authored-by: Benjamin Fan <ben-git@swinglonga.com>
Reviewed-on: https://codeberg.org/freesewing/freesewing/pulls/367
Reviewed-by: Joost De Cock <joostdecock@noreply.codeberg.org>
Co-authored-by: Benjamin Fan <benjamesben@noreply.codeberg.org>
Co-committed-by: Benjamin Fan <benjamesben@noreply.codeberg.org>
2025-05-19 08:04:05 +02:00
..
readme.mdx fix(reference:api): Revert incorrect Example formatting (#367) 2025-05-19 08:04:05 +02:00

---
title: Snippet.attr()
---

The `Snippet.attr()` method can be used to add attributes to the Snippet
object.  It calls `this.attributes.add()` under the hood, and returns the
Snippet object.

If the third parameter is set to `true` it will call `this.attributes.set()`
instead, thereby overwriting the value of the attribute.

## Signature

```js
Snippet snippet.attr(
  string name,
  mixed value,
  bool overwrite = false
)
```

:::tip
This method is chainable as it returns the `Snippet` object
:::

## Example

<Example caption="An example of the Snippet.attr() method">
```js
({ Point, points, Path, paths, Snippet, snippets, part }) => {

  snippets.logo = new Snippet('logo', new Point(0,0))
    .attr("data-scale", 0.75)
    .attr("data-rotate", 180)

  // Prevent clipping
  paths.diag = new Path()
    .move(new Point(-25,-10))
    .move(new Point(25,35))

  return part
}
```
</Example>

:::note RELATED
See [Using Attributes](/howtos/code/attributes)
for information about what Attributes can be used with Snippets.
:::