Giter Club home page Giter Club logo

figma-orgchart's Introduction

Orgchart โ€“ a figma plugin

Create an org chart in Figma from a JSON or a YAML file. Try it here.

Figma Orgchart

Run the plugin locally

  • Clone the repository: git clone https://github.com/mamuso/figma-orgchart.git
  • Go to the directory: cd figma-orgchart
  • Install dependencies: npm i
  • Build the plugin: npm run watch
  • In the Figma desktop app, open a Figma document, and go to Plugins > Development > Import plugin from manifest
  • Select the figma-orgchart/manifest.json file

If you run the plugin locally, you can edit src/defautChartData.json to change the default chart data.

JSON/YAML data

You need to provide a JSON or a YAML with your team structure. You can use the following keys:

  • team: name of the team
  • manager: will be represented at the top of the team
  • members: array of members of a team
  • teams: array of teams
  • section: it will create a label with the text that you provide

Each manager and member can have the following keys:

  • name: name of the person
  • alias: title alias of the person. By default, it will expect a GitHub alias and will try to fill the avatar
  • meta: additional information that you'll like to provide
  • avatar: you can override the avatar providing a URL of an image

Aditional configurations

By default, the plugin assumes the following configuration:

{
  "avatar": true,
  "name": true,
  "alias": true,
  "meta": true,
  "ogurl": "https://github.com/",
  "color": {
    "border": "EEECF3",
    "background": "FFFFFF",
    "primarytext": "444D56",
    "secondarytext": "A1A6AA"
  },
  "text": {
    "label": { "family": "Helvetica Neue", "style": "Bold", "size": 20 },
    "section": { "family": "Helvetica Neue", "style": "Bold", "size": 18 },
    "name": { "family": "Helvetica Neue", "style": "Bold", "size": 16 },
    "alias": { "family": "Helvetica Neue", "style": "Regular", "size": 12 },
    "meta": { "family": "Helvetica Neue", "style": "Regular", "size": 12 }
  }
}

You can change the default configuration by adding a config key to the root of the JSON/YAML file. Check some of the examples below to learn how to change the design of the chart.

Examples

An org chart with Avatar, Name, Alias, and Meta

Loading avatars from Twitter

Hidding Alias and Meta field

Only shows the name

Loading avatars from URLs

Using custom colors

Using custom fonts

Sections

figma-orgchart's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.