PPolaris ComponentsConnect an agent

Country Visibility

A settings card that scopes where a widget appears, with a titled description and a full-width country visibility select, built with Polaris Card, BlockStack, Text and Select.

Preview

Code

Example.jsx
import { useState } from 'react';
import { BlockStack, Box, Button, Card, Checkbox, Collapsible, Icon, InlineGrid, InlineStack, Modal, Select, Tag, Text, TextField } from '@shopify/polaris';
import { ChevronDownIcon, ChevronUpIcon, SearchIcon } from '@shopify/polaris-icons';

const MAX_VISIBLE_TAGS = 3;

const REGIONS = [
  {
    label: 'Africa',
    value: 'AF',
    childRegion: [
      { label: 'Algeria', value: 'DZ' },
      { label: 'Angola', value: 'AO' },
      { label: 'Benin', value: 'BJ' },
      { label: 'Botswana', value: 'BW' },
      { label: 'British Indian Ocean Territory', value: 'IO' },
      { label: 'Burkina Faso', value: 'BF' },
      { label: 'Burundi', value: 'BI' },
      { label: 'Cabo Verde', value: 'CV' },
      { label: 'Cameroon', value: 'CM' },
      { label: 'Central African Republic', value: 'CF' },
      { label: 'Chad', value: 'TD' },
      { label: 'Comoros', value: 'KM' },
      { label: 'Congo - Brazzaville', value: 'CG' },
      { label: 'Congo - Kinshasa', value: 'CD' },
      { label: 'Côte d\'Ivoire', value: 'CI' },
      { label: 'Djibouti', value: 'DJ' },
      { label: 'Egypt', value: 'EG' },
      { label: 'Equatorial Guinea', value: 'GQ' },
      { label: 'Eritrea', value: 'ER' },
      { label: 'Eswatini', value: 'SZ' },
      { label: 'Ethiopia', value: 'ET' },
      { label: 'French Southern Territories', value: 'TF' },
      { label: 'Gabon', value: 'GA' },
      { label: 'Gambia', value: 'GM' },
      { label: 'Ghana', value: 'GH' },
      { label: 'Guinea', value: 'GN' },
      { label: 'Guinea-Bissau', value: 'GW' },
      { label: 'Kenya', value: 'KE' },
      { label: 'Lesotho', value: 'LS' },
      { label: 'Liberia', value: 'LR' },
      { label: 'Libya', value: 'LY' },
      { label: 'Madagascar', value: 'MG' },
      { label: 'Malawi', value: 'MW' },
      { label: 'Mali', value: 'ML' },
      { label: 'Mauritania', value: 'MR' },
      { label: 'Mauritius', value: 'MU' },
      { label: 'Mayotte', value: 'YT' },
      { label: 'Morocco', value: 'MA' },
      { label: 'Mozambique', value: 'MZ' },
      { label: 'Namibia', value: 'NA' },
      { label: 'Niger', value: 'NE' },
      { label: 'Nigeria', value: 'NG' },
      { label: 'Réunion', value: 'RE' },
      { label: 'Rwanda', value: 'RW' },
      { label: 'Sao Tome & Principe', value: 'ST' },
      { label: 'Senegal', value: 'SN' },
      { label: 'Seychelles', value: 'SC' },
      { label: 'Sierra Leone', value: 'SL' },
      { label: 'Somalia', value: 'SO' },
      { label: 'South Africa', value: 'ZA' },
      { label: 'South Sudan', value: 'SS' },
      { label: 'Saint Helena', value: 'SH' },
      { label: 'Sudan', value: 'SD' },
      { label: 'Tanzania', value: 'TZ' },
      { label: 'Togo', value: 'TG' },
      { label: 'Tristan da Cunha', value: 'TA' },
      { label: 'Tunisia', value: 'TN' },
      { label: 'Uganda', value: 'UG' },
      { label: 'Western Sahara', value: 'EH' },
      { label: 'Zambia', value: 'ZM' },
      { label: 'Zimbabwe', value: 'ZW' },
    ],
  },
  {
    label: 'Asia',
    value: 'AS',
    childRegion: [
      { label: 'Afghanistan', value: 'AF' },
      { label: 'Armenia', value: 'AM' },
      { label: 'Azerbaijan', value: 'AZ' },
      { label: 'Bahrain', value: 'BH' },
      { label: 'Bangladesh', value: 'BD' },
      { label: 'Bhutan', value: 'BT' },
      { label: 'Brunei', value: 'BN' },
      { label: 'Cambodia', value: 'KH' },
      { label: 'China', value: 'CN' },
      { label: 'Georgia', value: 'GE' },
      { label: 'Hong Kong SAR', value: 'HK' },
      { label: 'India', value: 'IN' },
      { label: 'Indonesia', value: 'ID' },
      { label: 'Iraq', value: 'IQ' },
      { label: 'Israel', value: 'IL' },
      { label: 'Japan', value: 'JP' },
      { label: 'Jordan', value: 'JO' },
      { label: 'Kazakhstan', value: 'KZ' },
      { label: 'Kuwait', value: 'KW' },
      { label: 'Kyrgyzstan', value: 'KG' },
      { label: 'Laos', value: 'LA' },
      { label: 'Lebanon', value: 'LB' },
      { label: 'Macao SAR', value: 'MO' },
      { label: 'Malaysia', value: 'MY' },
      { label: 'Maldives', value: 'MV' },
      { label: 'Mongolia', value: 'MN' },
      { label: 'Myanmar (Burma)', value: 'MM' },
      { label: 'Nepal', value: 'NP' },
      { label: 'Oman', value: 'OM' },
      { label: 'Pakistan', value: 'PK' },
      { label: 'Palestinian Territories', value: 'PS' },
      { label: 'Philippines', value: 'PH' },
      { label: 'Qatar', value: 'QA' },
      { label: 'Saudi Arabia', value: 'SA' },
      { label: 'Singapore', value: 'SG' },
      { label: 'South Korea', value: 'KR' },
      { label: 'Sri Lanka', value: 'LK' },
      { label: 'Taiwan', value: 'TW' },
      { label: 'Tajikistan', value: 'TJ' },
      { label: 'Thailand', value: 'TH' },
      { label: 'Timor-Leste', value: 'TL' },
      { label: 'Türkiye', value: 'TR' },
      { label: 'Turkmenistan', value: 'TM' },
      { label: 'United Arab Emirates', value: 'AE' },
      { label: 'Uzbekistan', value: 'UZ' },
      { label: 'Vietnam', value: 'VN' },
      { label: 'Yemen', value: 'YE' },
    ],
  },
  {
    label: 'Europe',
    value: 'EU',
    childRegion: [
      { label: 'Åland Islands', value: 'AX' },
      { label: 'Albania', value: 'AL' },
      { label: 'Andorra', value: 'AD' },
      { label: 'Austria', value: 'AT' },
      { label: 'Belarus', value: 'BY' },
      { label: 'Belgium', value: 'BE' },
      { label: 'Bosnia & Herzegovina', value: 'BA' },
      { label: 'Bulgaria', value: 'BG' },
      { label: 'Croatia', value: 'HR' },
      { label: 'Cyprus', value: 'CY' },
      { label: 'Czechia', value: 'CZ' },
      { label: 'Denmark', value: 'DK' },
      { label: 'Estonia', value: 'EE' },
      { label: 'Faroe Islands', value: 'FO' },
      { label: 'Finland', value: 'FI' },
      { label: 'France', value: 'FR' },
      { label: 'Germany', value: 'DE' },
      { label: 'Gibraltar', value: 'GI' },
      { label: 'Greece', value: 'GR' },
      { label: 'Guernsey', value: 'GG' },
      { label: 'Hungary', value: 'HU' },
      { label: 'Iceland', value: 'IS' },
      { label: 'Ireland', value: 'IE' },
      { label: 'Isle of Man', value: 'IM' },
      { label: 'Italy', value: 'IT' },
      { label: 'Jersey', value: 'JE' },
      { label: 'Kosovo', value: 'XK' },
      { label: 'Latvia', value: 'LV' },
      { label: 'Liechtenstein', value: 'LI' },
      { label: 'Lithuania', value: 'LT' },
      { label: 'Luxembourg', value: 'LU' },
      { label: 'Malta', value: 'MT' },
      { label: 'Moldova', value: 'MD' },
      { label: 'Monaco', value: 'MC' },
      { label: 'Montenegro', value: 'ME' },
      { label: 'Netherlands', value: 'NL' },
      { label: 'North Macedonia', value: 'MK' },
      { label: 'Norway', value: 'NO' },
      { label: 'Poland', value: 'PL' },
      { label: 'Portugal', value: 'PT' },
      { label: 'Romania', value: 'RO' },
      { label: 'Russia', value: 'RU' },
      { label: 'San Marino', value: 'SM' },
      { label: 'Serbia', value: 'RS' },
      { label: 'Slovakia', value: 'SK' },
      { label: 'Slovenia', value: 'SI' },
      { label: 'Spain', value: 'ES' },
      { label: 'Svalbard & Jan Mayen', value: 'SJ' },
      { label: 'Sweden', value: 'SE' },
      { label: 'Switzerland', value: 'CH' },
      { label: 'Ukraine', value: 'UA' },
      { label: 'United Kingdom', value: 'GB' },
      { label: 'Vatican City', value: 'VA' },
    ],
  },
  {
    label: 'North America',
    value: 'NA',
    childRegion: [
      { label: 'Anguilla', value: 'AI' },
      { label: 'Antigua & Barbuda', value: 'AG' },
      { label: 'Aruba', value: 'AW' },
      { label: 'Bahamas', value: 'BS' },
      { label: 'Barbados', value: 'BB' },
      { label: 'Belize', value: 'BZ' },
      { label: 'Bermuda', value: 'BM' },
      { label: 'Bonaire', value: 'BQ' },
      { label: 'British Virgin Islands', value: 'VG' },
      { label: 'Canada', value: 'CA' },
      { label: 'Cayman Islands', value: 'KY' },
      { label: 'Costa Rica', value: 'CR' },
      { label: 'Curaçao', value: 'CW' },
      { label: 'Dominica', value: 'DM' },
      { label: 'Dominican Republic', value: 'DO' },
      { label: 'El Salvador', value: 'SV' },
      { label: 'Greenland', value: 'GL' },
      { label: 'Grenada', value: 'GD' },
      { label: 'Guadeloupe', value: 'GP' },
      { label: 'Guatemala', value: 'GT' },
      { label: 'Haiti', value: 'HT' },
      { label: 'Honduras', value: 'HN' },
      { label: 'Jamaica', value: 'JM' },
      { label: 'Martinique', value: 'MQ' },
      { label: 'Mexico', value: 'MX' },
      { label: 'Montserrat', value: 'MS' },
      { label: 'Nicaragua', value: 'NI' },
      { label: 'Panama', value: 'PA' },
      { label: 'Puerto Rico', value: 'PR' },
      { label: 'Sint Maarten', value: 'SX' },
      { label: 'St. Kitts & Nevis', value: 'KN' },
      { label: 'St. Lucia', value: 'LC' },
      { label: 'St. Pierre & Miquelon', value: 'PM' },
      { label: 'St. Vincent', value: 'VC' },
      { label: 'Trinidad & Tobago', value: 'TT' },
      { label: 'Turks & Caicos Islands', value: 'TC' },
      {
        label: 'United States',
        value: 'US',
        childRegion: [
          { label: 'Alabama', value: 'Alabama' },
          { label: 'Alaska', value: 'Alaska' },
          { label: 'Arizona', value: 'Arizona' },
          { label: 'Arkansas', value: 'Arkansas' },
          { label: 'California', value: 'California' },
          { label: 'Colorado', value: 'Colorado' },
          { label: 'Connecticut', value: 'Connecticut' },
          { label: 'Delaware', value: 'Delaware' },
          { label: 'Florida', value: 'Florida' },
          { label: 'Georgia', value: 'Georgia' },
          { label: 'Hawaii', value: 'Hawaii' },
          { label: 'Idaho', value: 'Idaho' },
          { label: 'Illinois', value: 'Illinois' },
          { label: 'Indiana', value: 'Indiana' },
          { label: 'Iowa', value: 'Iowa' },
          { label: 'Kansas', value: 'Kansas' },
          { label: 'Kentucky', value: 'Kentucky' },
          { label: 'Louisiana', value: 'Louisiana' },
          { label: 'Maine', value: 'Maine' },
          { label: 'Maryland', value: 'Maryland' },
          { label: 'Massachusetts', value: 'Massachusetts' },
          { label: 'Michigan', value: 'Michigan' },
          { label: 'Minnesota', value: 'Minnesota' },
          { label: 'Mississippi', value: 'Mississippi' },
          { label: 'Missouri', value: 'Missouri' },
          { label: 'Montana', value: 'Montana' },
          { label: 'Nebraska', value: 'Nebraska' },
          { label: 'Nevada', value: 'Nevada' },
          { label: 'New Hampshire', value: 'New Hampshire' },
          { label: 'New Jersey', value: 'New Jersey' },
          { label: 'New Mexico', value: 'New Mexico' },
          { label: 'New York', value: 'New York' },
          { label: 'North Carolina', value: 'North Carolina' },
          { label: 'North Dakota', value: 'North Dakota' },
          { label: 'Ohio', value: 'Ohio' },
          { label: 'Oklahoma', value: 'Oklahoma' },
          { label: 'Oregon', value: 'Oregon' },
          { label: 'Pennsylvania', value: 'Pennsylvania' },
          { label: 'Rhode Island', value: 'Rhode Island' },
          { label: 'South Carolina', value: 'South Carolina' },
          { label: 'South Dakota', value: 'South Dakota' },
          { label: 'Tennessee', value: 'Tennessee' },
          { label: 'Texas', value: 'Texas' },
          { label: 'Utah', value: 'Utah' },
          { label: 'Vermont', value: 'Vermont' },
          { label: 'Virginia', value: 'Virginia' },
          { label: 'Washington', value: 'Washington' },
          { label: 'Washington DC', value: 'Washington DC' },
          { label: 'West Virginia', value: 'West Virginia' },
          { label: 'Wisconsin', value: 'Wisconsin' },
          { label: 'Wyoming', value: 'Wyoming' },
        ],
      },
      { label: 'US Virgin Islands', value: 'VI' },
    ],
  },
  {
    label: 'Oceania',
    value: 'OC',
    childRegion: [
      { label: 'Australia', value: 'AU' },
      { label: 'Christmas Island', value: 'CX' },
      { label: 'Cocos (Keeling) Islands', value: 'CC' },
      { label: 'Cook Islands', value: 'CK' },
      { label: 'Fiji', value: 'FJ' },
      { label: 'French Polynesia', value: 'PF' },
      { label: 'Guam', value: 'GU' },
      { label: 'Heard Island & McDonald Islands', value: 'HM' },
      { label: 'Kiribati', value: 'KI' },
      { label: 'Marshall Islands', value: 'MH' },
      { label: 'Micronesia, Federated States of', value: 'FM' },
      { label: 'Nauru', value: 'NR' },
      { label: 'New Caledonia', value: 'NC' },
      { label: 'New Zealand', value: 'NZ' },
      { label: 'Niue', value: 'NU' },
      { label: 'Norfolk Island', value: 'NF' },
      { label: 'Northern Mariana Islands', value: 'MP' },
      { label: 'Palau', value: 'PW' },
      { label: 'Papua New Guinea', value: 'PG' },
      { label: 'Pitcairn', value: 'PN' },
      { label: 'Samoa', value: 'WS' },
      { label: 'Solomon Islands', value: 'SB' },
    ],
  },
  {
    label: 'South America',
    value: 'SA',
    childRegion: [
      { label: 'Argentina', value: 'AR' },
      { label: 'Bolivia', value: 'BO' },
      { label: 'Brazil', value: 'BR' },
      { label: 'Chile', value: 'CL' },
      { label: 'Colombia', value: 'CO' },
      { label: 'Ecuador', value: 'EC' },
      { label: 'Falkland Islands', value: 'FK' },
      { label: 'French Guiana', value: 'GF' },
      { label: 'Guyana', value: 'GY' },
      { label: 'Paraguay', value: 'PY' },
      { label: 'Peru', value: 'PE' },
      { label: 'South Georgia & South Sandwich Islands', value: 'GS' },
      { label: 'Suriname', value: 'SR' },
      { label: 'Uruguay', value: 'UY' },
      { label: 'Venezuela', value: 'VE' },
    ],
  },
];

const VISIBILITY_OPTIONS = [
  { label: 'Show in all countries', value: 'all' },
  { label: 'Show only in selected countries', value: 'showOnly' },
  { label: 'Hide in selected countries', value: 'hideIn' },
];

const collectValues = (list) =>
  list.flatMap((item) => (item.childRegion ? collectValues(item.childRegion) : [item.value]));

const countTotal = (list) => collectValues(list).length;

const countSelected = (list, chosen) =>
  collectValues(list).filter((value) => chosen.includes(value)).length;

const buildLabels = (list) =>
  list.reduce((map, item) => {
    if (item.childRegion) return { ...map, ...buildLabels(item.childRegion) };
    return { ...map, [item.value]: item.label };
  }, {});

const TOTAL_COUNT = countTotal(REGIONS);
const LABEL_BY_CODE = buildLabels(REGIONS);
const COUNTRY_NODES = REGIONS.flatMap((region) => region.childRegion);

const resolveChecked = (value, childRegion, chosen) => {
  if (!childRegion) return chosen.includes(value);
  const leaves = collectValues(childRegion);
  if (leaves.every((leaf) => chosen.includes(leaf))) return true;
  return leaves.some((leaf) => chosen.includes(leaf)) ? 'indeterminate' : false;
};

const LIST_STYLES = `
  .CountryVisibility-Region {
    cursor: pointer;
    background-color: var(--p-color-bg-surface-secondary);
    border-block-start: 0.0625rem solid var(--p-color-border);
    border-block-end: 0.0625rem solid var(--p-color-border);
  }
  .CountryVisibility-Region:hover {
    background-color: var(--p-color-bg-surface-secondary-hover);
  }
  .CountryVisibility-Country {
    cursor: pointer;
  }
  .CountryVisibility-Country:hover {
    background-color: var(--p-color-bg-surface-hover);
  }
`;

const RegionRow = ({ label, value, childRegion, chosen, onToggle, level = 1 }) => {
  const [open, setOpen] = useState(false);
  const checked = resolveChecked(value, childRegion, chosen);
  const hasChildren = Boolean(childRegion);

  return (
    <>
      <div className={level === 1 ? 'CountryVisibility-Region' : 'CountryVisibility-Country'}>
        <InlineGrid columns="auto 1fr">
          <InlineStack blockAlign="center">
            <Box paddingBlock="0" paddingInlineStart={level < 3 ? '300' : '1000'}>
              <Checkbox
                label={label}
                labelHidden
                checked={checked}
                onChange={() => onToggle(value, checked, childRegion)}
              />
            </Box>
          </InlineStack>
          <div
            onClick={() =>
              hasChildren ? setOpen((prev) => !prev) : onToggle(value, checked, childRegion)
            }
          >
            <Box paddingBlock="300" paddingInlineStart="100" paddingInlineEnd="300">
              <InlineStack align="space-between" blockAlign="center">
                <Text as="span" fontWeight={level === 1 ? 'medium' : 'regular'}>
                  {label}
                </Text>
                {hasChildren && (
                  <InlineStack blockAlign="center">
                    <Text as="span">
                      {countSelected(childRegion, chosen)}/{countTotal(childRegion)}
                    </Text>
                    <Icon source={open ? ChevronUpIcon : ChevronDownIcon} />
                  </InlineStack>
                )}
              </InlineStack>
            </Box>
          </div>
        </InlineGrid>
      </div>
      {hasChildren && (
        <Collapsible
          open={open}
          id={`country-visibility-${value}`}
          transition={{ duration: '200ms', timingFunction: 'ease-in-out' }}
        >
          {childRegion.map((child) => (
            <RegionRow
              key={child.value}
              label={child.label}
              value={child.value}
              childRegion={child.childRegion}
              chosen={chosen}
              onToggle={onToggle}
              level={level + 1}
            />
          ))}
        </Collapsible>
      )}
    </>
  );
};

export const Example = () => {
  const [visibilityMode, setVisibilityMode] = useState('all');
  const [countryList, setCountryList] = useState(['CA', 'GB', 'JP', 'VN']);
  const [modalOpen, setModalOpen] = useState(false);
  const [chosen, setChosen] = useState(['CA', 'GB', 'JP', 'VN']);
  const [searchText, setSearchText] = useState('');

  const showCountrySelector = visibilityMode !== 'all';
  const visibleTags = countryList.slice(0, MAX_VISIBLE_TAGS);
  const moreCount = countryList.length - MAX_VISIBLE_TAGS;
  const searched = COUNTRY_NODES.filter((country) =>
    country.label.toLowerCase().includes(searchText.trim().toLowerCase())
  );

  const openModal = () => {
    setChosen(countryList);
    setSearchText('');
    setModalOpen(true);
  };

  const handleToggle = (value, currentChecked, childRegion) => {
    setChosen((prev) => {
      if (childRegion) {
        const leaves = collectValues(childRegion);
        if (currentChecked === true) return prev.filter((item) => !leaves.includes(item));
        return [...new Set([...prev, ...leaves])];
      }
      return prev.includes(value) ? prev.filter((item) => item !== value) : [...prev, value];
    });
  };

  return (
    <>
      <style>{LIST_STYLES}</style>
      <Card>
        <BlockStack gap="400">
          <BlockStack gap="100">
            <Text variant="bodyMd" as="span" fontWeight="semibold">
              Country visibility
            </Text>
            <Text variant="bodySm" as="p" tone="subdued">
              Control which countries your widget appears in.
            </Text>
          </BlockStack>

          <Select
            label="Country visibility"
            labelHidden
            options={VISIBILITY_OPTIONS}
            value={visibilityMode}
            onChange={setVisibilityMode}
          />

          {showCountrySelector && (
            <BlockStack gap="200">
              <Text variant="bodyMd" as="span">
                Countries
              </Text>

              {countryList.length === 0 ? (
                <InlineStack align="space-between" blockAlign="center">
                  <Text as="span" tone="subdued">
                    No countries selected
                  </Text>
                  <Button variant="plain" onClick={openModal}>
                    Edit
                  </Button>
                </InlineStack>
              ) : (
                <InlineStack gap="200" blockAlign="center" wrap>
                  {visibleTags.map((code) => (
                    <Tag
                      key={code}
                      onRemove={() => setCountryList((prev) => prev.filter((item) => item !== code))}
                    >
                      {LABEL_BY_CODE[code] || code}
                    </Tag>
                  ))}
                  {moreCount > 0 && <Tag>+{moreCount} more</Tag>}
                  <Button variant="plain" onClick={openModal}>
                    Edit
                  </Button>
                </InlineStack>
              )}
            </BlockStack>
          )}
        </BlockStack>
      </Card>

      <Modal
        open={modalOpen}
        onClose={() => setModalOpen(false)}
        title="Select countries"
        primaryAction={{
          content: 'Select',
          onAction: () => {
            setCountryList(chosen);
            setModalOpen(false);
          },
        }}
        secondaryActions={[{ content: 'Cancel', onAction: () => setModalOpen(false) }]}
      >
        <Modal.Section>
          <BlockStack gap="500">
            <InlineStack align="space-between" blockAlign="center">
              <Text variant="headingMd" as="span">
                Countries/regions
              </Text>
              <Text as="span">
                {chosen.length} of {TOTAL_COUNT} selected
              </Text>
            </InlineStack>
            <BlockStack gap="200">
              <TextField
                label="Search countries"
                labelHidden
                placeholder="Search"
                prefix={<Icon source={SearchIcon} />}
                value={searchText}
                onChange={setSearchText}
                autoComplete="off"
                clearButton
                onClearButtonClick={() => setSearchText('')}
              />
              <BlockStack>
                {searchText.trim()
                  ? searched.map((country) => (
                      <RegionRow
                        key={country.value}
                        label={country.label}
                        value={country.value}
                        childRegion={country.childRegion}
                        chosen={chosen}
                        onToggle={handleToggle}
                        level={2}
                      />
                    ))
                  : REGIONS.map((region) => (
                      <RegionRow
                        key={region.value}
                        label={region.label}
                        value={region.value}
                        childRegion={region.childRegion}
                        chosen={chosen}
                        onToggle={handleToggle}
                      />
                    ))}
              </BlockStack>
            </BlockStack>
          </BlockStack>
        </Modal.Section>
      </Modal>
    </>
  );
};