README.md

Retool Org Chart

Retool Custom Component Wrapper for https://github.com/bumbeishvili/org-chart

Deploy in Retool

1. Checkout the repo

   git clone https://github.com/fortunabmc/retool-org-chart

2. Install dependencies

   npm install

3. Login to Retool

   npx retool-ccl login

4. Deploy to Retool

   npx retool-ccl deploy

5. Component will be available in Retool Editor

   

Configure via Retool Editor

User List

The user list is an array of objects, defining the heirarchy and user info.

The following is an example interface for the component.

IUser

interface IUser {
  // mandatory props
  id: string | number;
  parentId: null; // `null` for the root node or an id of another `IUser`
  // optional data
  name: string;
  email: string;
  position: string;
  imageUrl: string;
  // ...
}

The underlying library will extend your IUser objects with the following additional properties.

NodeProps

interface NodeProps {
  _expanded: boolean;
  _pagingStep: number;
  _pagingButton: boolean;
  _totalSubordinates: number;
  _directSubordinates: number;
  _directSubordinatesPaging: number;
}

Node Template CSS & Node Template HTML

Under the hood, these two fields use Mustache.js as a template engine.

The delimeters have been set to <? and ?> to prevent interferenece with Retool's {{ vars }}

Both the CSS and HTML templates have the user object as <? user.PROP ?> and the additional props defined in NodeProps.

If your user object has user.name = "Tom" then in the HTML template you can use <? user.name ?>.

Also available are:

• <? node.width ?>
• <? node.height ?>
• <? node.lineColor ?>

Examples with variable interpolation

Template CSS

:root {
  --profile-image-radius: 32px;
  --border-radius: 6px;
  --footer-height: 32px;
  --accent-bar-height: 10px;
}

.container {
  display: flex;
  flex-direction: column;
  overflow: visible;
  height: <? node.height ?>px;
  background-color: #fff;
  border-radius: var(--border-radius);

  div.accent {
    margin-top: -48px;
    height: var(--accent-bar-height);
    border-radius: var(--border-radius) var(--border-radius) 0 0;
    background-color: <? node.linkColor ?>;
  }

  header {
    text-align: center;

    img {
      width: calc((var(--profile-image-radius) - 2px) * 2);
      height: calc((var(--profile-image-radius) - 2px) * 2);
      margin-top: -20px;
      border-radius: 100px;
      border: 2px solid <? node.linkColor ?>;
    }
  }

  section {
    flex-grow: 1;
    padding: 50px 10px 0;
    text-align: center;

    .name {
      color: #111672;
      font-size: 16px;
      font-weight: bold;
    }

    .position {
      color: #404040;
      font-size: 16px;
      margin-top: 4px;
    }
  }

  footer {
    display: flex;
    justify-content: space-between;
    padding: 5px 8px;
  }
}

Example Template HTML

<div class="container">
  <header>
    <img src="<? user.imageUrl ?>" />
    <div class="accent"></div>
  </header>
  <section>
    <div class="name"><? user.name ?></div>
    <div class="position"><? user.positionName ?></div>
  </section>
  <footer>
    <div>Manages:&nbsp;<? user._directSubordinates ?>&nbsp;👤</div>
    <div>Oversees:&nbsp;<? user._totalSubordinates ?>&nbsp;👤</div>
  </footer>
</div>

Events

onNodeClick

When a node is clicked, the IUser with NodeProps will be set to the onNodeClicked state property of the Component.

Org Chart Options

Name	Type	Description	Initial Value	Inspector	Enum Definition
User List	array	Array of users with id and parentId
Layout Style	enumeration	Direction of layout for the tree	left	segmented	left, top, bottom, right
Show Control Buttons	boolean		true	checkbox
Node Height	number	Height of the rendered node	200
Node Width	number	Width of the rendered node	250
Parent / Child Gap	number	Vertical spacing between parent and children	60
Siblings Gap	number	Horizontal spacing between sibling nodes	60
Neighbor Spacing	number	Horizontal spacing between groups of child nodes	80
Child X Gap	number	Horizontal spacing between sibling child nodes	100
Child Y Gap	number	Vertical spacing between sibling child nodes	50
Link Width	number	Stroke width of the links between nodes	2
Link Color	string	Color for the links between nodes	#FFF
Node Template CSS	string	CSS for rendering the nodes. Define classes and use them in node HTML. EX: Hello
Node Template HTML	string	HTML template for rendering the nodes. User and Node props available as vars to templates. EX: Hello
onNodeClick	object		[object Object]	hidden

Example App

A Demo Retool App json is also available for import.