• Stars
    star
    190
  • Rank 203,739 (Top 5 %)
  • Language
    Shell
  • License
    MIT License
  • Created over 4 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Typings for the Figma Plugin API

Figma Plugin API typings

npm

This repository contains the typings for the Figma Plugin API.

Usage

  1. Installation

    npm i --save-dev @figma/plugin-typings
    # or
    yarn add -D @figma/plugin-typings
  2. Configure tsconfig.json

    {
        "compilerOptions": {
            "typeRoots": [
                "./node_modules/@types",
                "./node_modules/@figma"
            ]
        }
    }

    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.

More Repositories

1

plugin-samples

πŸ”Œ Sample Figma plugins.
TypeScript
1,479
star
2

figma-api-demo

JavaScript
1,316
star
3

code-connect

A tool for connecting your design system components in code with your design system in Figma
TypeScript
812
star
4

plugin-resources

A collection of open source plugins, widgets and other resources for Figma + FigJam that have been shared on GitHub.
600
star
5

sds

Simple Design System (SDS) is a base design system that shows how Figma’s Variables, Styles, Components, and Code Connect can be used alongside a React codebase to form a complete picture of a responsive web design system.
TypeScript
289
star
6

code-snippet-editor-plugin

Translate component variants, properties, and more into dynamic code snippets for your design system.
TypeScript
129
star
7

widget-samples

FigJam widget code examples & starter projects using the FigJam Widget API
TypeScript
100
star
8

variables-github-action-example

Example GitHub Actions workflows for syncing variables to Figma
TypeScript
98
star
9

ai-plugin-template

An example of making a Figma plugin that talks to OpenAI GPT models.
TypeScript
90
star
10

strict-null-check-migration-tools

Scripts used to migrate Figma's codebase to strictNullChecks
TypeScript
73
star
11

webgl-profiler

A GPU-side profiler for WebGL using EXT_disjoint_timer_query
JavaScript
69
star
12

rest-api-spec

OpenAPI specification and types for the Figma REST API
64
star
13

dynamic-universal-app

Size efficient alternative to macOS universal binaries
Objective-C
57
star
14

architecture-diagram-components

Figma / FigJam components for creating beautiful and informative architecture diagrams.
40
star
15

community

The Official Figma Community
24
star
16

create-widget

Create new FigJam widgets with a single command.
JavaScript
17
star
17

eslint-plugin-figma-plugins

typescript-eslint rules for plugins
TypeScript
16
star
18

widget-typings

Typings for the Figma Widget API
Shell
11
star
19

sorbet-rails

Forked from https://github.com/chanzuckerberg/sorbet-rails
Ruby
3
star
20

it-eng-pub

it-eng-pub
1
star
21

terraform-provider-figma

Go
1
star
22

mergequeue-eval-mergify

Test repository to evaluate the Mergify merge queue
JavaScript
1
star
23

gpumon-datadog

JavaScript
1
star
24

mergequeue-eval-bors

For testing bors
JavaScript
1
star
25

terraform-provider-aws-4-49-0

Go
1
star