Multi Level Select

Summary

Default

The MultiLevelSelect kit renders a multi leveled select dropdown based on data from the user. treeData is a required prop that is expected to contain the data in the form of an array of objects. See code snippet for an example data array.

For the React version of the kit, the onSelect prop returns an array of objects. This array contains all checked items irrespective of whether it is a parent, child or grandchild. Open the console on this example and check and uncheck checkboxes to see this is action!

For the Rails version of the kit, there is no onselect. The form submits as a array of strings, following the typical rails pattern of utilizing hidden inputs. The strings are the values of the selected items' ids. For example, ["103", "106", "107"].

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "business Affairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-default-rails",
    name: "my_array",
    tree_data: treeData
}) %>

Single Select

Optionally enable the single variant to replace checkboxes with radios so the input accepts and returns only a single selection.

<% treeData = [
  {
    label: "HQ",
    value: "hQ",
    id: "hq",
  },
  {
    label: "Philadelphia",
    value: "philadelphia",
    id: "phl",
    children: [
      {
        label: "Marketing & Sales PHL",
        value: "marketingAndSalesPhl",
        id: "marketingPHL",
      },
      {
        label: "Installation Office PHL",
        value: "installationOfficePhl",
        id: "installationPHL",
      },
      {
        label: "Warehouse PHL",
        value: "warehousePhl",
        id: "warehousePHL",
      },
    ]
  },
  {
    label: "New Jersey",
    value: "newJersey",
    id: "nj",
    children: [
      {
        label: "New Jersey",
        value: "newJersey",
        id: "nj1",
        children: [
          {
            label: "Marketing & Sales NJ",
            value: "marketingAndSalesNj",
            id: "marketingNJ",
          },
          {
            label: "Installation Office NJ",
            value: "installationOfficeNj",
            id: "installationNJ",
          },
          {
            label: "Warehouse NJ",
            value: "warehouseNj",
            id: "warehouseNJ",
          },
        ],
      },
      {
        label: "Princeton",
        value: "princeton",
        id: "princeton",
        children: [
          {
            label: "Marketing & Sales Princeton",
            value: "marketingAndSalesPrinceton",
            id: "marketingPR",
          },
          {
            label: "Installation Office Princeton",
            value: "installationOfficePrinceton",
            id: "installationPR",
          },
          {
            label: "Warehouse Princeton",
            value: "warehousePrinceton",
            id: "warehousePR",
          },
        ]
      },
    ]
  },
  {
    label: "Maryland",
    value: "maryland",
    id: "MD",
    children: [
      {
        label: "Marketing & Sales MD",
        value: "marketingAndSalesMd",
        id: "marketingMD",
      },
      {
        label: "Installation Office MD",
        value: "installationOfficeMd",
        id: "installationMD",
      },
      {
        label: "Warehouse MD",
        value: "warehouseMd",
        id: "warehouseMD",
      },
    ]
  },
  {
    label: "Connecticut",
    value: "connecticut",
    id: "CT",
    children: [
      {
        label: "Marketing & Sales CT",
        value: "marketingAndSalesCt",
        id: "marketingCT",
      },
      {
        label: "Installation Office CT",
        value: "installationOfficeCt",
        id: "installationCT",
      },
      {
        label: "Warehouse CT",
        value: "warehouseCt",
        id: "warehouseCT",
      },
    ]
  },
]; %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-single-rails",
    name: "my_single_select_array",
    tree_data: treeData,
    input_name: "Power",
    variant: "single"
}) %>

Single Select w/ Hidden Radios

Dynamically control your selectable options by passing hideRadio: true to any node within your tree data to omit that node's radio selector. In this example we've hidden all radios except ultimate children (nodes without descendants).

<% treeData = [
  {
    label: "HQ",
    value: "hQ",
    id: "hq1",
  },
  {
    label: "Philadelphia",
    value: "philadelphia",
    id: "phl1",
    hideRadio: true,
    children: [
      {
        label: "Marketing & Sales PHL",
        value: "marketingAndSalesPhl",
        id: "marketingPHL1",
      },
      {
        label: "Installation Office PHL",
        value: "installationOfficePhl",
        id: "installationPHL1",
      },
      {
        label: "Warehouse PHL",
        value: "warehousePHL",
        id: "warehousePHL1",
      },
    ]
  },
  {
    label: "New Jersey",
    value: "newJersey",
    id: "nj2",
    hideRadio: true,
    children: [
      {
        label: "New Jersey",
        value: "newJersey",
        id: "nj3",
        hideRadio: true,
        children: [
          {
            label: "Marketing & Sales NJ",
            value: "marketingAndSalesNj",
            id: "marketingNJ1",
          },
          {
            label: "Installation Office NJ",
            value: "installationOfficeNj",
            id: "installationNJ1",
          },
          {
            label: "Warehouse NJ",
            value: "warehouseNj",
            id: "warehouseNJ1",
          },
        ],
      },
      {
        label: "Princeton",
        value: "princeton",
        id: "princeton1",
        hideRadio: true,
        children: [
          {
            label: "Marketing & Sales Princeton",
            value: "marketingAndSalesPrinceton",
            id: "marketingPR1",
          },
          {
            label: "Installation Office Princeton",
            value: "installationOfficePrinceton",
            id: "installationPR1",
          },
          {
            label: "Warehouse Princeton",
            value: "warehousePrinceton",
            id: "warehousePR1",
          },
        ]
      },
    ]
  },
  {
    label: "Maryland",
    value: "maryland",
    id: "MD1",
    hideRadio: true,
    children: [
      {
        label: "Marketing & Sales MD",
        value: "marketingAndSalesMd",
        id: "marketingMD1",
      },
      {
        label: "Installation Office MD",
        value: "installationOfficeMd",
        id: "installationMD1",
      },
      {
        label: "Warehouse MD",
        value: "warehouseMd",
        id: "warehouseMD1",
      },
    ]
  },
  {
    label: "Connecticut",
    value: "connecticut",
    id: "CT1",
    hideRadio: true,
    children: [
      {
        label: "Marketing & Sales CT",
        value: "marketingAndSalesCt",
        id: "marketingCT1",
      },
      {
        label: "Installation Office CT",
        value: "installationOfficeCt",
        id: "installationCT1",
      },
      {
        label: "Warehouse CT",
        value: "warehouseCt",
        id: "warehouseCT1",
      },
    ]
  },
]; %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-single-children-only-rails",
    name: "my_single_children_only_select_array",
    tree_data: treeData,
    input_name: "PowerChildren",
    variant: "single"
}) %>

Return All Selected

The returnAllSelected or return_all_selected prop can be used when users want data on all checked nodes from the dropdown, irrespective of whether it is a parent or child node.

NOTE: This variant also does not automatically uncheck the parent when any of the child nodes are unchecked. returnAllSelected is set to false by default.

NOTE: For larger trees that may return many pill selections, you can optionally set input_display: "none"(for Rails) or inputDisplay = "none"(for React) to hide all pills within the input.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-return-all-selected-rails",
    name: "my_data_array",
    tree_data: treeData,
    return_all_selected: true
}) %>

With Input Display None

Use the inputDisplay/input_display prop to optionally display only the count in the display as opposed to multiple pills. This prop is set to 'pills' by default.

NOTE: inputDisplay/input_display is particularly useful for larger trees that may return many pill selections, helping to keep the input field clean and compact. This prop should not be used with the Single Select variant.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-input-display-none",
    name: :foo,
    tree_data: treeData,
    input_display: "none",
    return_all_selected: true,
    })
%>

Selected Ids

selected_ids is an optional prop that accepts an array of ids that, if present, will mark the corresponding nodes on the treeData as checked on page load.

Items that include checked:true on the treeData itself will also be selected on page load, even without being passed to selectedIds.

When an item is marked as checked on page load by any means, the dropdown will expand to show the checked items for easier accessibility.

When using selected_ids and variant: "single" together (see single select doc examples), the selected_ids array should contain only one id, because only one item can be selected and displayed at a time. If the selected_ids array has multiple ids in it, the first id in the array will be the treeData node checked upon page load.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-seelcted_ids",
    name: "my_data_array_selected",
    return_all_selected: true,
    selected_ids:["110","102"],
    tree_data: treeData,
}) %>

With Form

<%= pb_form_with(scope: :example, url: "", method: :get) do |form| %>

  <% treeData = [{
  label: "Power Home Remodeling",
  value: "powerHomeRemodeling",
  id: "powerhome1",
  expanded: true,
  children: [
    {
      label: "People",
      value: "people",
      id: "people1",
      children: [
        {
          label: "Talent Acquisition",
          value: "talentAcquisition",
          id: "talent1",
        },
        {
          label: "Business Affairs",
          value: "businessAffairs",
          id: "business1",
          children: [
            {
              label: "Initiatives",
              value: "initiatives",
              id: "initiative1",
            },
            {
              label: "Learning & Development",
              value: "learningAndDevelopment",
              id: "development1",
            },
          ],
        },
        {
          label: "People Experience",
          value: "peopleExperience",
          id: "experience1",
        },
      ],
    },
    {
      label: "Contact Center",
      value: "contactCenter",
      id: "contact1",
      children: [
        {
          label: "Appointment Management",
          value: "appointmentManagement",
          id: "appointment1",
        },
        {
          label: "Customer Service",
          value: "customerService",
          id: "customer1",
        },
        {
          label: "Energy",
          value: "energy",
          id: "energy1",
        },
      ],
    },
  ],
}] %>

  <%= form.multi_level_select :example, props: {id: "with-form-multi-level-select", tree_data: treeData, return_all_selected: true, margin_bottom: "sm" } %>
  <%= form.actions do |action| %>
    <%= action.button props: { type: "submit", text: "Submit", variant: "primary", margin_top: "lg" } %>
  <% end %>   
<% end %>

With Pills (Custom Color)

Change the form pill color by passing the optional pill_color prop. Product, Data, and Status colors are available options. Check them out here in the Form Pill colors example.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-default-rails",
    name: "my_array",
    tree_data: treeData,
    pill_color: "neutral"
}) %>

Reset Selection

In order to clear the multilevelselect selection using an external trigger (like a reset button), the clearMultiLevelSelect function can be used. See the code snippet below to see this in action. The function is scoped by id so an id MUST be used on the multilevelselect kit and passed to the function as shown for it to work.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-reset-example",
    name: "my_array",
    tree_data: treeData,
    return_all_selected: true
}) %>

<%= pb_rails("button", props: { text: "Reset", margin_top: "lg", id:"multilevelselect-reset-button" }) %>

<script>
  window.addEventListener('DOMContentLoaded', () => {
    const exampleResetButton = document.querySelector("#multilevelselect-reset-button");

    exampleResetButton.addEventListener("click", () => {
        clearMultiLevelSelectById('multi-level-select-reset-example');
      });
    function clearMultiLevelSelectById(id) {
      const clearFunction = window[`clearMultiLevelSelect_${id}`];
      if (clearFunction) {
        clearFunction();
      } else {
        console.warn(`No clear function found for MultiLevelSelect with id: ${id}`);
      }
    }
  })
</script>

With Label

The MultiLevelSelect component optionally accepts a label prop to produce a label above the input.

Add an id to wire the label to the input so that clicking the label will move focus directly to the input, and open the drop-down.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
  id: "select_a_department",
  label: "Select a Department",
  tree_data: treeData
}) %>

Error

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    error: "Please make a valid selection",
    id: "multi-level-select-error-rails",
    name: "my_array",
    tree_data: treeData
}) %>

Disabled Input

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    disabled: true,
    id: "multi-level-select-disabled-rails",
    name: "my_array",
    tree_data: treeData
}) %>

Disabled Options (Default)

To disable individual items in the treeData, include disabled:true within the object on the treeData that you want disabled. See the code snippet below for an example of how to do this.

If a parent is selected, the parent will be returned in the selected items list, even if it has disabled children.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "powerhome1",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "people1",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "talent1",
            disabled: true,
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "business1",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "initiative1",
                disabled: true,
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "development1",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "experience1",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "contact1",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "appointment1",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "customer1",
            disabled: true,
          },
          {
            label: "Energy",
            value: "energy",
            id: "energy1",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-disabled-options-default-rails",
    name: "disabled_options_default",
    tree_data: treeData
}) %>

Disabled Options (Return All Selected)

Individual items can also be disabled by including the disabled:true within the object on the treeData for the returnAllSelected/return_all_selected variant. As noted above, this variant will return data on all checked nodes from the dropdown, irrespective of whether it is a parent or child node.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "powerhome1",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "people1",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "talent1",
            disabled: true,
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "business1",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "initiative1",
                disabled: true,
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "development1",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "experience1",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "contact1",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "appointment1",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "customer1",
            disabled: true,
          },
          {
            label: "Energy",
            value: "energy",
            id: "energy1",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-disabled-options-rails",
    name: "disabled_options",
    return_all_selected: true,
    tree_data: treeData
}) %>

Disabled Parent Option (Default)

For the default variant, disabling the parent item will automatically disable it's children as well.

If you want to be able to disable a parent WITHOUT disabling it's children, use the returnAllSelected/return_all_selected variant.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "powerhome1",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "people1",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "talent1",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "business1",
            expanded: true,
            disabled: true,
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "initiative1",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "development1",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "experience1",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "contact1",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "appointment1",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "customer1",
          },
          {
            label: "Energy",
            value: "energy",
            id: "energy1",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "mls-disabled-options-parent-default-rails",
    name: "disabled_options_parent_default",
    tree_data: treeData
}) %>

Disabled Parent Option (Return All Selected)

For the returnAllSelected/return_all_selected variant, disabling the parent item will NOT automatically disable it's children since this version allows you to select a parent even if all children are unselected.

You can manually pass disabled:true to any and all children of a disabled parent if you want to do so.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "powerhome1",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "people1",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "talent1",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "business1",
            expanded: true,
            disabled: true,
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "initiative1",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "development1",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "experience1",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "contact1",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "appointment1",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "customer1",
          },
          {
            label: "Energy",
            value: "energy",
            id: "energy1",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
    id: "mls-disabled-options-parent-rails",
    name: "disabled_options_parent",
    return_all_selected: true,
    tree_data: treeData
}) %>

Disabled Options (Single Select)

Individual items can be disabled by including disabled: true within the object on the treeData for the single variant. Disabled options are visibly disabled in the dropdown UI and cannot be selected via mouse click or keyboard navigation. When a parent node is disabled, all of its children are automatically disabled as well.

<% treeData = [
  {
    label: "HQ",
    value: "hQ",
    id: "hq2",
  },
  {
    label: "Philadelphia",
    value: "philadelphia",
    id: "phl2",
    disabled: true,
    children: [
      {
        label: "Marketing & Sales PHL",
        value: "marketingAndSalesPhl",
        id: "marketingPHL2",
      },
      {
        label: "Installation Office PHL",
        value: "installationOfficePhl",
        id: "installationPHL2",
      },
      {
        label: "Warehouse PHL",
        value: "warehousePhl",
        id: "warehousePHL2",
      },
    ]
  },
  {
    label: "New Jersey",
    value: "newJersey",
    id: "nj2",
    children: [
      {
        label: "New Jersey",
        value: "newJersey",
        id: "nj12",
        children: [
          {
            label: "Marketing & Sales NJ",
            value: "marketingAndSalesNj",
            id: "marketingNJ2",
            disabled: true,
          },
          {
            label: "Installation Office NJ",
            value: "installationOfficeNj",
            id: "installationNJ2",
          },
          {
            label: "Warehouse NJ",
            value: "warehouseNj",
            id: "warehouseNJ2",
          },
        ],
      },
      {
        label: "Princeton",
        value: "princeton",
        id: "princeton2",
        children: [
          {
            label: "Marketing & Sales Princeton",
            value: "marketingAndSalesPrinceton",
            id: "marketingPR2",
          },
          {
            label: "Installation Office Princeton",
            value: "installationOfficePrinceton",
            id: "installationPR2",
            disabled: true,
          },
          {
            label: "Warehouse Princeton",
            value: "warehousePrinceton",
            id: "warehousePR2",
          },
        ]
      },
    ]
  },
  {
    label: "Maryland",
    value: "maryland",
    id: "MD2",
    children: [
      {
        label: "Marketing & Sales MD",
        value: "marketingAndSalesMd",
        id: "marketingMD2",
      },
      {
        label: "Installation Office MD",
        value: "installationOfficeMd",
        id: "installationMD2",
      },
      {
        label: "Warehouse MD",
        value: "warehouseMd",
        id: "warehouseMD2",
      },
    ]
  },
  {
    label: "Connecticut",
    value: "connecticut",
    id: "CT2",
    children: [
      {
        label: "Marketing & Sales CT",
        value: "marketingAndSalesCt",
        id: "marketingCT2",
      },
      {
        label: "Installation Office CT",
        value: "installationOfficeCt",
        id: "installationCT2",
      },
      {
        label: "Warehouse CT",
        value: "warehouseCt",
        id: "warehouseCT2",
      },
    ]
  },
] %>

<%= pb_rails("multi_level_select", props: {
    id: "multi-level-select-single-disabled-rails",
    name: "single_disabled",
    tree_data: treeData,
    input_name: "Power",
    variant: "single"
}) %>

Required Indicator

The requiredIndicator/required_indicator prop displays a red asterisk (*) next to the label, visually indicating that the field is required. This is purely visual and does not enforce validation.

You can use requiredIndicator/required_indicator with any validation approach: HTML5 validation via the required prop, client-side validation, or backend validation. For this reason, it works independently and doesn't need to be paired with the required prop.

<% treeData = [{
    label: "Power Home Remodeling",
    value: "powerHomeRemodeling",
    id: "100",
    expanded: true,
    children: [
      {
        label: "People",
        value: "people",
        id: "101",
        expanded: true,
        children: [
          {
            label: "Talent Acquisition",
            value: "talentAcquisition",
            id: "102",
          },
          {
            label: "Business Affairs",
            value: "businessAffairs",
            id: "103",
            children: [
              {
                label: "Initiatives",
                value: "initiatives",
                id: "104",
              },
              {
                label: "Learning & Development",
                value: "learningAndDevelopment",
                id: "105",
              },
            ],
          },
          {
            label: "People Experience",
            value: "peopleExperience",
            id: "106",
          },
        ],
      },
      {
        label: "Contact Center",
        value: "contactCenter",
        id: "107",
        children: [
          {
            label: "Appointment Management",
            value: "appointmentManagement",
            id: "108",
          },
          {
            label: "Customer Service",
            value: "customerService",
            id: "109",
          },
          {
            label: "Energy",
            value: "energy",
            id: "110",
          },
        ],
      },
    ],
}] %>

<%= pb_rails("multi_level_select", props: {
  id: "select_a_department",
  label: "Select a Department",
  required_indicator: true,
  tree_data: treeData
}) %>

Placeholder

Use the placeholder prop to customize the initial text shown in the input when nothing is selected. The default is Start typing....

<%
  tree_base = [{
      label: "Power Home Remodeling",
      value: "powerHomeRemodeling",
      id: "100",
      expanded: true,
      children: [
        {
          label: "People",
          value: "people",
          id: "101",
          expanded: true,
          children: [
            {
              label: "Talent Acquisition",
              value: "talentAcquisition",
              id: "102",
            },
            {
              label: "Business Affairs",
              value: "business Affairs",
              id: "103",
              children: [
                {
                  label: "Initiatives",
                  value: "initiatives",
                  id: "104",
                },
                {
                  label: "Learning & Development",
                  value: "learningAndDevelopment",
                  id: "105",
                },
              ],
            },
            {
              label: "People Experience",
              value: "peopleExperience",
              id: "106",
            },
          ],
        },
        {
          label: "Contact Center",
          value: "contactCenter",
          id: "107",
          children: [
            {
              label: "Appointment Management",
              value: "appointmentManagement",
              id: "108",
            },
            {
              label: "Customer Service",
              value: "customerService",
              id: "109",
            },
            {
              label: "Energy",
              value: "energy",
              id: "110",
            },
          ],
        },
      ],
  }]

  prefix_mls_ids = nil
  prefix_mls_ids = ->(nodes, pfx) {
    nodes.map do |n|
      h = n.dup
      h[:id] = "#{pfx}#{n[:id]}"
      h[:children] = prefix_mls_ids.call(n[:children], pfx) if n[:children].present?
      h
    end
  }

  tree_multi = prefix_mls_ids.call(tree_base, "phm_")
  tree_return_all = prefix_mls_ids.call(tree_base, "phr_")
  tree_single = prefix_mls_ids.call(tree_base, "phs_")
%>

<%= pb_rails("multi_level_select", props: {
  id: "multi-level-select-placeholder-multi-rails",
  label: "Multi (default)",
  margin_bottom: "sm",
  name: "placeholder_multi",
  tree_data: tree_multi,
  placeholder: "Search or choose options…",
}) %>

<%= pb_rails("multi_level_select", props: {
  id: "multi-level-select-placeholder-return-all-rails",
  label: "Multi (return all selected)",
  margin_bottom: "sm",
  name: "placeholder_return_all",
  placeholder: "Departments...",
  return_all_selected: true,
  tree_data: tree_return_all,
}) %>

<%= pb_rails("multi_level_select", props: {
  id: "multi-level-select-placeholder-single-rails",
  label: "Single",
  name: "placeholder_single",
  placeholder: "Select one option…",
  tree_data: tree_single,
  variant: "single",
}) %>

Available Props

Props	Type	Values
align_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
align_items	enum \| responsive	start end center
border_radius	enum	none xs sm md lg xl rounded
cursor	enum	auto default none contextMenu help pointer progress wait cell
dark	boolean	true false
flex	enum \| responsive	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_direction	enum \| responsive	row column rowReverse columnReverse
flex_wrap	enum \| responsive	wrap nowrap wrapReverse
justify_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
line_height	enum	loosest looser loose normal tight tighter tightest
margin_right	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_x	array	none xxs xs sm md lg xl
margin_y	array	none xxs xs sm md lg xl
margin	array	none xxs xs sm md lg xl
width	string
min_width	string
max_width	string
gap	string \| responsive
column_gap	string \| responsive
row_gap	string \| responsive
number_spacing	enum	tabular
order	enum \| responsive	none first 1 2 3 4 5 6 7 8 9 10 11 12
overflow_x	enum	scroll visible hidden auto
overflow_y	enum	scroll visible hidden auto
overflow	enum	scroll visible hidden auto
padding_right	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_x	array	none xxs xs sm md lg xl
padding_y	array	none xxs xs sm md lg xl
padding	array	none xxs xs sm md lg xl
position	enum	relative absolute fixed sticky static
shadow	enum	none deep deeper deepest
text_align	enum \| responsive	start end left right center justify justifyAll matchParent
truncate	enum	none 1 2 3 4 5
vertical_align	enum \| responsive	baseline super top middle bottom sub text-top text-bottom
z_index	enum \| responsive	1 2 3 4 5 6 7 8 9 10 max
top	enum \| object	xxs xs sm md lg xl xxl
inset	boolean	true false
right	enum \| object	xxs xs sm md lg xl xxl
bottom	enum \| object	xxs xs sm md lg xl xxl
left	enum \| object	xxs xs sm md lg xl xxl
height	string
max_height	string
min_height	string
hover	object
group_hover	boolean	true false

Props	Type	Values	Default
disabled	boolean	true false	false
error	string
input_display	"pills" \| "none"	pills none	pills
input_name	string
label	string
name	string
required	boolean	true false	false
required_indicator	boolean	true false	false
return_all_selected	boolean	true false	false
show_checked_children	boolean	true false	true
tree_data	{ [key: string]: string }[] \| any
on_change	function
on_select	function
placeholder	string		Start typing...
selected_ids	string[] \| any
variant	"multi" \| "single"	multi single	multi
wrapped	boolean	true false	false
pill_color	enum	primary neutral success warning error info data_1 data_2 data_3 data_4 data_5 data_6 data_7 data_8 windows siding roofing doors gutters solar insulation accessories	primary

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Github

Connect Chat

Multi Level Select

Available Props

align_content

align_items

border_radius

cursor

dark

flex

flex_direction

flex_wrap

justify_content

line_height

margin_right

margin_left

margin_top

margin_bottom

margin_x

margin_y

margin

width

min_width

max_width

gap

column_gap

row_gap

number_spacing

order

overflow_x

overflow_y

overflow

padding_right

padding_left

padding_top

padding_bottom

padding_x

padding_y

padding

position

shadow

text_align

truncate

vertical_align

z_index

top

inset

right

bottom

left

height

max_height

min_height

hover

group_hover

disabled

error

input_display

input_name

label

name

required

required_indicator

return_all_selected

show_checked_children

tree_data

on_change

on_select

placeholder

selected_ids

variant

wrapped

pill_color

Contribute to Playbook

Power

Connect