Installations

npm install @figma/plugin-typings

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Node Version

22.10.0

NPM Version

10.9.0 Score

99.9

Supply Chain

81.4

Quality

98.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

245

Closed

40

Merged

205

Issues

Open

5

Total

74

Closed

69

Releases

Unable to fetch releases

Contributors

69

View All 69 Contributors

Languages

1

Shell

Shell (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

figma

Download Statistics

Total Downloads

4,174,037

Last Day

1,447

Last Week

57,115

Last Month

232,142

Last Year

2,162,883

GitHub Statistics

MIT License

206 Stars

501 Commits

46 Forks

76 Watchers

30 Branches

69 Contributors

Updated on Feb 16, 2025

Maintainers

49

Package Meta Information

Latest Version

1.107.0

Package Id

@figma/plugin-typings@1.107.0

Unpacked Size

159.09 kB

Size

35.37 kB

File Count

10

NPM Version

10.9.0

Node Version

22.10.0

Published on

Feb 13, 2025

Total Downloads

Cumulative downloads

Total Downloads

4,174,037

Last Day

15.8%

1,447

Compared to previous day

Last Week

-10.7%

57,115

Compared to previous week

Last Month

48.1%

232,142

Compared to previous month

Last Year

68.9%

2,162,883

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

1

prettier

Figma Plugin API typings

This repository contains the typings for the Figma Plugin API.

Usage

Installation

1npm i --save-dev @figma/plugin-typings
2# or
3yarn add -D @figma/plugin-typings

Configure tsconfig.json
```
1{
2    "compilerOptions": {
3        "typeRoots": [
4            "./node_modules/@types",
5            "./node_modules/@figma"
6        ]
7    }
8}
```
The configuration above is needed for the TypeScript compiler to use type definitions found in both ./node_modules/@types and ./node_modules/@figma. Normally, most external type definitions are from DefinitelyTyped and are installed in /@types, which included by TypeScript by default. Since we host the plugin typings separately, they are installed outside in /@figma instead.

Types should become globally available without needing to use import statements. We do it this way because the plugin API is part of the host environment, as opposed to being a package that a plugin includes.

About

Plugin API releases have the format "Version X, Update Y". Equivalent tags are created in this repository as v<x>.<y>. Note that not all API releases include API changes, some are just bug fixes. Therefore, some typings versions are skipped.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

8

Maintained

Determines if the project is "actively maintained".

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.5

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More