Installations

npm install @figma/widget-typings

Pull Requests

Open

0

Total

34

Closed

2

Merged

32

Issues

Open

1

Total

3

Closed

2

Releases

Unable to fetch releases

Developer

figma

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

Typescript Support

Yes

Node Version

20.14.0

NPM Version

10.7.0 Statistics

11 Stars

104 Commits

6 Forks

59 Watching

25 Branches

18 Contributors

Updated on 22 Nov 2024

Languages

Shell (100%)

Total Downloads

Cumulative downloads

Total Downloads

638,067

Last day

-31.9%

924

Compared to previous day

Last week

-11.3%

5,348

Compared to previous week

Last month

0.2%

28,921

Compared to previous month

Last year

88.3%

375,252

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

1

@figma/plugin-typings

Dev Dependencies

1

prettier

Versions

Figma Widget API typings

This repository contains the typings for the Figma Widget API.

Usage

Installation

Note that the widget api is an extention of the plugin api so you should install both @figma/plugin-typings and @figma/widget-typings
```
1npm i --save-dev @figma/plugin-typings @figma/widget-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 & widget 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 widget API is part of the host environment, as opposed to being a package that a plugin includes.

About

Widget 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

License

Determines if the project has defined a license.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Code-Review

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

3

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

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

0

Pinned-Dependencies

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

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.2

/10

Last Scanned on 2024-11-25

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