Function reference • figma

Get data of a Figma file

Functions to get the data of a Figma file, or a specific page, or just the metadata of the file.

get_figma_file(): Get data of a Figma File from the API

get_figma_page(): Get data of a specific canvas/page in a Figma File from the API

get_document_info(): Get the document metadata of a Figma File from the API

Fit the Figma data into a more flexible and intuitive data structure

Functions to extract the data of your Figma file from the raw HTTP response object, and fit it into a more flexible and intuitive data structure.

as_tibble(): Convert a httr response object to a tibble object

as_figma_document(): Convert a httr response object to a Figma Document object

Example data and global variables

Global variables used across the package, or, data used in the code examples across vignettes and documentations.

untitled_file: An example of a simple Figma file

quarto_website: A representation of a Quarto Website home webpage

default_attrs: Default attributes of every Figma node

document_attrs: Default document attributes of a Figma file

URL and endpoint utilities

These are mainly utilities functions that are used to get (or build) the complete URLs used in the HTTP requests.

build_query_string(): Build a query string from a set of named parameters

build_request_url(): Build the request URL

get_endpoint_url(): Get the URL to a endpoint of Figma API

Other non-exported utility functions

These are utilities functions that are not exported to the user. But they are documented in the package.

parse_response_object(): Parse the response data and fit it into a R object

select_any_of(): Select any of the elements in a object