{"id":112,"date":"2023-05-18T15:51:51","date_gmt":"2023-05-18T22:51:51","guid":{"rendered":"https:\/\/comm.engineering.asu.edu\/pitchfork\/?post_type=pitchfork-docs&#038;p=112"},"modified":"2024-07-10T16:23:40","modified_gmt":"2024-07-10T23:23:40","slug":"web-directory-block","status":"publish","type":"pitchfork-docs","link":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/","title":{"rendered":"Web Directory Block"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"styles\">Styles and layouts<\/h2>\n\n\n\n<p>Within the dimensions panel, users can adjust the top and bottom margin of the block as needed.<\/p>\n\n\n\n<p>Other styles and layout decisions for the directories produced by this block are all enforced at the package level directly from the Unity project. <\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"settings\">Required settings<\/h2>\n\n\n\n<p>The web directory block requires three configured fields in order to display a full directory from ASU Search.<\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-full is-resized is-style-drop-shadow\"><img loading=\"lazy\" decoding=\"async\" width=\"502\" height=\"716\" src=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2.png\" alt=\"\" class=\"wp-image-289\" style=\"width:300px\" srcset=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2.png 502w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2-210x300.png 210w\" sizes=\"auto, (max-width: 502px) 100vw, 502px\" \/><figcaption class=\"wp-element-caption\">The block provides for the display of two different directory styles. Both styles can be displayed with one or more departments selected and can be limited to a specific number of results per returned page.<\/figcaption><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"records-per-page\">Number of records per page<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>The default setting for the number of returned records for this block is 20.<\/li>\n\n\n\n<li>The recommended range for the number of returned records is between 10 and 25.<\/li>\n\n\n\n<li>Returning additional results will slow down the page&#8217;s load time due to a large number of records being returned from Search.<\/li>\n\n\n\n<li>A returned list of greater than 25 records also results in a page length that is hard to navigate particularly on a mobile device. <\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"departments\">Department selection<\/h3>\n\n\n\n<p>The select box within the settings panel for the block provides a list of all directory groups within ASU Search. This list is automatically populated each time the block edit screen is accessed. <\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Select one or more departments from the dropdown menu.<\/li>\n\n\n\n<li>The order of the selected departments is configurable by rearranging the selected names in the dropdown list.<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"display-type\">Display Type<\/h3>\n\n\n\n<p>The block provides two different methods to display a directory.<\/p>\n\n\n\n<p class=\"is-style-lead\" style=\"margin-top:var(--wp--preset--spacing--uds-size-6)\"><strong>Director<\/strong>y<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Useful for displaying lists of staff and mixed groups of faculty and staff members.<\/li>\n\n\n\n<li>View an example from the <a href=\"https:\/\/unity.web.asu.edu\/@asu\/app-webdir-ui\/index.html?path=\/story\/organisms-web-directory-templates--web-directory-example-departments\">Storybook component browser <\/a>within the Unity project.<\/li>\n<\/ul>\n\n\n\n<p>When the <code>web-directory<\/code> block is configured to display a <strong>standard directory<\/strong>, it optionally can be enclosed in a set of column blocks. This layout is typically used in conjunction with the sidebar block to provide for a secondary navigation to other directory pages within the same site.<\/p>\n\n\n\n<p>There is no current option to adjust the select box for sorting the results so that it aligns with the left side of the block.<\/p>\n\n\n\n<p class=\"is-style-lead\"><strong>Ranked Faculty<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Displays a list of faculty members ranked by academic achievement and bestowed titles. <\/li>\n\n\n\n<li>This display will omit any member of a department that is not explicitly a faculty member in ASU Search.<\/li>\n\n\n\n<li>View an example from the <a href=\"https:\/\/unity.web.asu.edu\/@asu\/app-webdir-ui\/index.html?path=\/story\/organisms-web-directory-templates--web-directory-example-departments\">Storybook component browser <\/a>within the Unity project.<\/li>\n<\/ul>\n\n\n\n<p>Ordinarily, the <code>web-directory<\/code> block should not be enclosed in a column block when it is configured to display a <strong>ranked faculty<\/strong> list.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>At widths of less than about 1200px, the tabs within the component will begin to scroll horizontally which is an undesirable look on desktop.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"filters\">Filters and Exclusions<\/h2>\n\n\n\n<p>The list of people produced by the web directory block can be filtered in a few different ways. People can either be manually excluded from appearing within the directory results or the list can be filtered by specific criteria.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Exclusions<\/h3>\n\n\n\n<p>Enter a comma separated list of ASURITE IDs into the appropriate field in the sidebar to exclude people from a given directory list. <\/p>\n\n\n\n<p>As ASURITE IDs are entered, the excluded profile will be outlined in red. The pagination indicator will also adjust to show how the exclusion has effected the results on each page.<\/p>\n\n\n\n<figure class=\"wp-block-image aligncenter size-large is-resized is-style-plain\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"623\" src=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-1024x623.png\" alt=\"Screenshot of how to enter exclusions within the web directory block.\" class=\"wp-image-287\" style=\"width:500px\" srcset=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-1024x623.png 1024w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-300x183.png 300w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-768x467.png 768w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image.png 1098w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Filters<\/h3>\n\n\n\n<p>Results from a directory can be filtered by any combination of three available criteria. A toggle within the block editor will reveal the filterable data points available to each profile within the directory. <\/p>\n\n\n\n<p>As filters are applied, the resulting list displays ONLY people that match the given criteria. <\/p>\n\n\n\n<p>Multiple criteria can be used within the same filter and multiple filters can be combined together to customize your list.<\/p>\n\n\n\n<p>The available filters are:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Expertise area<\/li>\n\n\n\n<li>Employee type<\/li>\n\n\n\n<li>Campus<\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image aligncenter size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1013\" height=\"1024\" src=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-1-1013x1024.png\" alt=\"Screen shot of filters available within the web directory block.\" class=\"wp-image-288\" style=\"width:500px\" srcset=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-1-1013x1024.png 1013w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-1-297x300.png 297w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-1-768x777.png 768w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-1.png 1070w\" sizes=\"auto, (max-width: 1013px) 100vw, 1013px\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"multiple\">Multiple blocks per page<\/h2>\n\n\n<div class=\"wp-block-alert alert is-style-alert-info\"><div class=\"alert-icon\"><span class=\"fas fa-check-circle\"><\/span><\/div><div class=\"alert-content\"><div class=\"acf-innerblocks-container\">\n\n<p>As of Pitchfork People v1.4.1, page editors should assign a unique HTML anchor to each <code>web-directory<\/code> block that is placed on a page. If there is no anchor provided, only the first <code>web-directory<\/code> block on the page will render results correctly. <\/p>\n\n<\/div><\/div><\/div>\n\n\n<p>Multiple <code>web-directory<\/code> blocks can be used on the same page to create complex layouts for on-campus groups with large organizational structures.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Be sure to assign a unique HTML anchor to each block you add to the page. Only one of the blocks will render correctly if you omit this step.<\/li>\n\n\n\n<li>Also be sure to set the pagination number on each <code>web-directory<\/code> block to a relatively small number. This will greatly speed up the initial page load time.<\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image aligncenter size-full is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"490\" height=\"456\" src=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/07\/image.png\" alt=\"\" class=\"wp-image-306\" style=\"width:300px\" srcset=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/07\/image.png 490w, https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/07\/image-300x279.png 300w\" sizes=\"auto, (max-width: 490px) 100vw, 490px\" \/><\/figure>\n","protected":false},"excerpt":{"rendered":"<p class=\"mb-2\">Deploy an entire directory from ASU Search onto a page. The faculty rank display is required for any listing of faculty within an academic unit. The web directory block is more versitile and can list faculty, staff and mixed groups.<\/p>\n","protected":false},"parent":0,"menu_order":3,"template":"","pitchfork-docs-category":[11],"class_list":["post-112","pitchfork-docs","type-pitchfork-docs","status-publish","hentry","pitchfork-docs-category-pitchfork-people"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.4 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Web Directory Block - Pitchfork Theme for WordPress<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Web Directory Block - Pitchfork Theme for WordPress\" \/>\n<meta property=\"og:description\" content=\"Deploy an entire directory from ASU Search onto a page. The faculty rank display is required for any listing of faculty within an academic unit. The web directory block is more versitile and can list faculty, staff and mixed groups.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/\" \/>\n<meta property=\"og:site_name\" content=\"Pitchfork Theme for WordPress\" \/>\n<meta property=\"article:modified_time\" content=\"2024-07-10T23:23:40+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2.png\" \/>\n\t<meta property=\"og:image:width\" content=\"502\" \/>\n\t<meta property=\"og:image:height\" content=\"716\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/\",\"url\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/\",\"name\":\"Web Directory Block - Pitchfork Theme for WordPress\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/wp-content\\\/uploads\\\/sites\\\/79\\\/2024\\\/06\\\/image-2.png\",\"datePublished\":\"2023-05-18T22:51:51+00:00\",\"dateModified\":\"2024-07-10T23:23:40+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/#primaryimage\",\"url\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/wp-content\\\/uploads\\\/sites\\\/79\\\/2024\\\/06\\\/image-2.png\",\"contentUrl\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/wp-content\\\/uploads\\\/sites\\\/79\\\/2024\\\/06\\\/image-2.png\",\"width\":502,\"height\":716},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/web-directory-block\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/docs\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Web Directory Block\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/#website\",\"url\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/\",\"name\":\"Pitchfork Theme for WordPress\",\"description\":\"an ASU Engineering theme for WordPress\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/comm.engineering.asu.edu\\\/pitchfork\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Web Directory Block - Pitchfork Theme for WordPress","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/","og_locale":"en_US","og_type":"article","og_title":"Web Directory Block - Pitchfork Theme for WordPress","og_description":"Deploy an entire directory from ASU Search onto a page. The faculty rank display is required for any listing of faculty within an academic unit. The web directory block is more versitile and can list faculty, staff and mixed groups.","og_url":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/","og_site_name":"Pitchfork Theme for WordPress","article_modified_time":"2024-07-10T23:23:40+00:00","og_image":[{"width":502,"height":716,"url":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/","url":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/","name":"Web Directory Block - Pitchfork Theme for WordPress","isPartOf":{"@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/#website"},"primaryImageOfPage":{"@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/#primaryimage"},"image":{"@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/#primaryimage"},"thumbnailUrl":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2.png","datePublished":"2023-05-18T22:51:51+00:00","dateModified":"2024-07-10T23:23:40+00:00","breadcrumb":{"@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/#primaryimage","url":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2.png","contentUrl":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-content\/uploads\/sites\/79\/2024\/06\/image-2.png","width":502,"height":716},{"@type":"BreadcrumbList","@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/web-directory-block\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/comm.engineering.asu.edu\/pitchfork\/"},{"@type":"ListItem","position":2,"name":"Documents","item":"https:\/\/comm.engineering.asu.edu\/pitchfork\/docs\/"},{"@type":"ListItem","position":3,"name":"Web Directory Block"}]},{"@type":"WebSite","@id":"https:\/\/comm.engineering.asu.edu\/pitchfork\/#website","url":"https:\/\/comm.engineering.asu.edu\/pitchfork\/","name":"Pitchfork Theme for WordPress","description":"an ASU Engineering theme for WordPress","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/comm.engineering.asu.edu\/pitchfork\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-json\/wp\/v2\/pitchfork-docs\/112","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-json\/wp\/v2\/pitchfork-docs"}],"about":[{"href":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-json\/wp\/v2\/types\/pitchfork-docs"}],"wp:attachment":[{"href":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-json\/wp\/v2\/media?parent=112"}],"wp:term":[{"taxonomy":"pitchfork-docs-category","embeddable":true,"href":"https:\/\/comm.engineering.asu.edu\/pitchfork\/wp-json\/wp\/v2\/pitchfork-docs-category?post=112"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}