<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[8714] sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select: WordCamp Blocks: Improvements to ItemSelect component</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/8714">8714</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/8714","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coreymckrill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-05-01 22:15:58 +0000 (Wed, 01 May 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>WordCamp Blocks: Improvements to ItemSelect component
* Abstract and memoize the functionality that builds the options set
* Abstract the component that displays a single option
* Add missing doc blocks
* JS linting cleanup</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginsblocksassetssrcshareditemselectindexjs">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/index.js</a></li>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginsblocksassetssrcshareditemselectstylescss">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/style.scss</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginsblocksassetssrcshareditemselectoptionjs">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/option.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginsblocksassetssrcshareditemselectindexjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/index.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/index.js 2019-05-01 22:13:13 UTC (rev 8713)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/index.js 2019-05-01 22:15:58 UTC (rev 8714)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,7 +17,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> import './style.scss';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Component for selecting one or more related entities to be used as content in a block.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class ItemSelect extends Component {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Run additional operations during component initialization.
+ *
+ * @param {Object} props
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> constructor( props ) {
</span><span class="cx" style="display: block; padding: 0 10px"> super( props );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,32 +33,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> selectedOptions: null,
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- this.isOptionDisabled = this.isOptionDisabled.bind( this );
</del><span class="cx" style="display: block; padding: 0 10px"> this.getNewAttributes = this.getNewAttributes.bind( this );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- isOptionDisabled( option, selected ) {
- const { mode } = this.props;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Determine if an option should be selectable based on what else is already selected.
+ *
+ * @param {Object} option
+ * @param {Array} selected
+ *
+ * @return {boolean}
+ */
+ static isOptionDisabled( option, selected ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> let chosen;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'loading' === option.type ) {
- return true;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( Array.isArray( selected ) && selected.length ) {
</span><span class="cx" style="display: block; padding: 0 10px"> chosen = selected[ 0 ].type;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( mode && mode !== option.type ) {
- return true;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> return chosen && chosen !== option.type;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Render the label of an option group.
+ *
+ * @param {Object} groupData
+ *
+ * @returns {Element}
+ */
+ static formatGroupLabel( groupData ) {
+ return (
+ <span className="wordcamp-item-select-option-group-label">
+ { groupData.label }
+ </span>
+ );
+ }
+
+ /**
+ * Convert a selection of options into values for a block's attributes.
+ *
+ * @return {Object}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> getNewAttributes() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const { selectedOptions } = this.state;
</ins><span class="cx" style="display: block; padding: 0 10px"> let attributes = {};
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- const { selectedOptions } = this.state;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null === selectedOptions ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return attributes;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -75,19 +101,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return attributes;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Render the select dropdown and related UI.
+ *
+ * @return {Element}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> render() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- const {
- instanceId, className, label, help, submitLabel,
- buildSelectOptions, onChange,
- selectProps,
- } = this.props;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const { instanceId, className, label, help, submitLabel, onChange, selectProps } = this.props;
</ins><span class="cx" style="display: block; padding: 0 10px"> const value = this.state.selectedOptions || this.props.value;
</span><span class="cx" style="display: block; padding: 0 10px"> const id = `wordcamp-item-select-control-${ instanceId }`;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> const mergedSelectProps = {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- options : buildSelectOptions(),
</del><span class="cx" style="display: block; padding: 0 10px"> isMulti : true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- isOptionDisabled : this.isOptionDisabled,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ isOptionDisabled : this.constructor.isOptionDisabled,
+ formatGroupLabel : this.constructor.formatGroupLabel,
</ins><span class="cx" style="display: block; padding: 0 10px"> ...selectProps,
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,7 +125,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> label={ label }
</span><span class="cx" style="display: block; padding: 0 10px"> help={ help }
</span><span class="cx" style="display: block; padding: 0 10px"> >
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <div className="wordcaselectedOptionsmp-item-select-inner">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <div className="wordcamp-item-select-inner">
</ins><span class="cx" style="display: block; padding: 0 10px"> <Select
</span><span class="cx" style="display: block; padding: 0 10px"> id={ id }
</span><span class="cx" style="display: block; padding: 0 10px"> className="wordcamp-item-select-select"
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,3 +151,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> export default withInstanceId( ItemSelect );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+export * from './option';
</ins></span></pre></div>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginsblocksassetssrcshareditemselectoptionjs"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/option.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/option.js (rev 0)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/option.js 2019-05-01 22:15:58 UTC (rev 8714)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,154 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * External dependencies
+ */
+import { get } from 'lodash';
+import createSelector from 'rememo';
+
+/**
+ * WordPress dependencies
+ */
+const { Dashicon } = wp.components;
+const { __ } = wp.i18n;
+
+/**
+ * Internal dependencies
+ */
+import { AvatarImage } from '../avatar';
+import { filterEntities } from '../../blocks-store';
+
+const buildOptionGroup = ( entityType, type, label, items ) => {
+ items = items.map( ( item ) => {
+ let parsedItem;
+
+ switch ( entityType ) {
+ case 'post':
+ parsedItem = {
+ label : item.title.rendered.trim() || __( '(Untitled)', 'wordcamporg' ),
+ value : item.id,
+ type : type,
+ };
+
+ parsedItem.avatar = get( item, 'avatar_urls[\'24\']', '' );
+ parsedItem.image = get( item, '_embedded[\'wp:featuredmedia\'].media_details.sizes.thumbnail.source_url', '' );
+ break;
+
+ case 'term':
+ parsedItem = {
+ label : item.name || __( '(Untitled)', 'wordcamporg' ),
+ value : item.id,
+ type : type,
+ count : item.count,
+ };
+ break;
+ }
+
+ return parsedItem;
+ } );
+
+ return {
+ label : label,
+ options : items,
+ };
+};
+
+/**
+ * A memoized function that parses structured data into a format used as an option set by ItemSelect.
+ *
+ * @return {Array}
+ */
+export const buildOptions = createSelector(
+ ( groups ) => {
+ const options = [];
+
+ groups.forEach( ( group ) => {
+ const { entityType, type, label, items } = group;
+ let orderby;
+
+ switch ( entityType ) {
+ case 'post':
+ orderby = 'title.rendered';
+ break;
+ case 'term':
+ orderby = 'name';
+ break;
+ }
+
+ if ( Array.isArray( items ) && items.length ) {
+ const sortedItems = filterEntities( items, { sort: orderby + '_asc' } );
+
+ options.push( buildOptionGroup( entityType, type, label, sortedItems ) );
+ }
+ } );
+
+ return options;
+ },
+ ( groups ) => {
+ const references = [];
+
+ groups.forEach( ( group ) => {
+ const { items } = group;
+
+ references.push( items );
+ } );
+
+ return references;
+ }
+);
+
+/**
+ * Component for a single option in an ItemSelect dropdown.
+ *
+ * Not all of the props need or should have a value. An option representing a speaker will have
+ * an avatar prop, but not an icon or a count (of terms).
+ *
+ * @param {Object} props {
+ * @type {string} avatar
+ * @type {string} icon
+ * @type {string} label
+ * @type {number} count
+ * }
+ *
+ * @return {Element}
+ */
+export function Option( { avatar, icon, label, count } ) {
+ let image;
+
+ if ( avatar ) {
+ image = (
+ <AvatarImage
+ className="wordcamp-item-select-option-avatar"
+ name={ label }
+ size={ 24 }
+ url={ avatar }
+ />
+ );
+ } else if ( icon ) {
+ image = (
+ <div className="wordcamp-item-select-option-icon-container">
+ <Dashicon
+ className="wordcamp-item-select-option-icon"
+ icon={ icon }
+ size={ 16 }
+ />
+ </div>
+ );
+ }
+
+ const content = (
+ <span className="wordcamp-item-select-option-label">
+ { label }
+ { 'undefined' !== typeof count &&
+ <span className="wordcamp-item-select-option-label-count">
+ { count }
+ </span>
+ }
+ </span>
+ );
+
+ return (
+ <div className="wordcamp-item-select-option">
+ { image }
+ { content }
+ </div>
+ );
+}
</ins></span></pre></div>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginsblocksassetssrcshareditemselectstylescss"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/style.scss</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/style.scss 2019-05-01 22:13:13 UTC (rev 8713)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/blocks/assets/src/shared/item-select/style.scss 2019-05-01 22:15:58 UTC (rev 8714)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,6 +33,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> align-items: center;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.wordcamp-item-select-option-avatar,
</ins><span class="cx" style="display: block; padding: 0 10px"> .wordcamp-item-select-option-icon-container {
</span><span class="cx" style="display: block; padding: 0 10px"> display: inline-flex;
</span><span class="cx" style="display: block; padding: 0 10px"> align-items: center;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,7 +48,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> white-space: normal;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-.wordcamp-item-select-option-label-term-count {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.wordcamp-item-select-option-label-count {
</ins><span class="cx" style="display: block; padding: 0 10px"> font-size: 0.6em;
</span><span class="cx" style="display: block; padding: 0 10px"> display: inline-block;
</span><span class="cx" style="display: block; padding: 0 10px"> border-radius: 50%;
</span></span></pre>
</div>
</div>
</body>
</html>