Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f0e6b28c34 | ||
|
|
b6589dd7a5 | ||
|
|
b9c0f1de47 | ||
|
|
3ee1247efe | ||
|
|
be1701eef3 |
@@ -1,6 +1,6 @@
|
||||
# Accordion
|
||||
|
||||
Accordion 1.0.0 ist ein listenbasiertes SPFx-WebPart für SharePoint Server Subscription Edition. Es orientiert
|
||||
Accordion 1.2.1 ist ein listenbasiertes SPFx-WebPart für SharePoint Server Subscription Edition. Es orientiert
|
||||
sich funktional am PnP-Beispiel `react-accordion-dynamic-section`, verwendet aber die mit SharePoint SE
|
||||
kompatible SPFx-1.4.1-/React-15-Toolchain.
|
||||
|
||||
@@ -8,8 +8,11 @@ kompatible SPFx-1.4.1-/React-15-Toolchain.
|
||||
|
||||
- Auswahl einer nicht ausgeblendeten Liste aus dem aktuellen Web
|
||||
- dynamische Auswahl von Überschrift-, Inhalt-, Kategorie- und Sortierspalte
|
||||
- konfigurierbarer WebPart-Titel
|
||||
- optionales Gruppieren nach Kategorien
|
||||
- Filter auf eine konkrete, aktuell in der Liste verwendete Kategorie
|
||||
- ein- und mehrwertige Managed-Metadata-Spalten als Kategorien
|
||||
- Auflösung interner WSS-IDs über die `TaxonomyHiddenList` der Site Collection
|
||||
- auf- oder absteigende Sortierung
|
||||
- initial vollständig geschlossen, erster Eintrag geöffnet oder alle Einträge geöffnet
|
||||
- wahlweise genau ein oder mehrere gleichzeitig geöffnete Bereiche
|
||||
@@ -26,7 +29,7 @@ Es wird keine fachliche Liste provisioniert. Eine einfache FAQ-Liste kann beispi
|
||||
|---|---|---|
|
||||
| `Title` | Eine Textzeile | Überschrift |
|
||||
| `Content` | Mehrere Textzeilen mit Rich Text | Inhalt |
|
||||
| `Category` | Auswahl oder Text | optionale Gruppierung |
|
||||
| `Category` | Auswahl, Text oder Managed Metadata | optionale Gruppierung |
|
||||
| `SortOrder` | Zahl | optionale Sortierung |
|
||||
|
||||
Nach dem Hinzufügen des WebParts werden Liste und Spalten im Property Pane ausgewählt. Sobald eine
|
||||
@@ -38,7 +41,7 @@ nächsten Laden beziehungsweise Rendern der Seite automatisch.
|
||||
|
||||
| Eigenschaft | Wert |
|
||||
|---|---|
|
||||
| Version | 1.0.0 |
|
||||
| Version | 1.2.1 |
|
||||
| SharePoint Framework | 1.4.1 |
|
||||
| React | 15.6.2 |
|
||||
| Node.js | 8.17.0 |
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
"name": "accordion-web-part",
|
||||
"title": "accordion-web-part",
|
||||
"id": "27a6fd90-42a1-4e39-8862-08ed0e7803bc",
|
||||
"version": "1.0.0.0",
|
||||
"version": "1.2.1.0",
|
||||
"includeClientSideAssets": true,
|
||||
"skipFeatureDeployment": true
|
||||
},
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "accordion-web-part",
|
||||
"version": "1.0.0",
|
||||
"version": "1.2.1",
|
||||
"private": true,
|
||||
"main": "lib/index.js",
|
||||
"engines": {
|
||||
@@ -9,7 +9,7 @@
|
||||
"scripts": {
|
||||
"build": "gulp bundle",
|
||||
"clean": "gulp clean",
|
||||
"test": "tsc --noEmit -p . && node tests/validate-project.js",
|
||||
"test": "tsc -p tests/tsconfig.json && node temp/tests/tests/AccordionCategoryValues.test.js && tsc --noEmit -p . && node tests/validate-project.js",
|
||||
"package": "npm test && gulp clean && gulp bundle --ship && gulp package-solution --ship"
|
||||
},
|
||||
"dependencies": {
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
export function getAccordionCategoryValues(value: any, splitPlainSemicolon?: boolean): string[] { // tslint:disable-line:no-any
|
||||
if (value === undefined || value === null) { return []; }
|
||||
const source: any[] = value && Array.isArray(value.results) ? value.results : [value]; // tslint:disable-line:no-any
|
||||
const values: string[] = [];
|
||||
const keys: { [key: string]: boolean } = {};
|
||||
for (let i: number = 0; i < source.length; i++) {
|
||||
const current: string[] = categoryEntryValues(source[i], splitPlainSemicolon === true);
|
||||
for (let valueIndex: number = 0; valueIndex < current.length; valueIndex++) {
|
||||
const text: string = current[valueIndex].trim();
|
||||
const key: string = '$' + text.toLocaleLowerCase();
|
||||
if (text && !keys[key]) { keys[key] = true; values.push(text); }
|
||||
}
|
||||
}
|
||||
return values;
|
||||
}
|
||||
|
||||
function categoryEntryValues(entry: any, splitPlainSemicolon: boolean): string[] { // tslint:disable-line:no-any
|
||||
if (entry === undefined || entry === null) { return []; }
|
||||
if (entry.Label) { return [String(entry.Label)]; }
|
||||
if (typeof entry !== 'string') {
|
||||
if (typeof entry === 'number' || typeof entry === 'boolean') { return [String(entry)]; }
|
||||
if (entry.Description || entry.Url) { return [String(entry.Description || entry.Url)]; }
|
||||
return [];
|
||||
}
|
||||
|
||||
const candidate: string = entry.trim();
|
||||
if (!candidate) { return []; }
|
||||
let parts: string[] = [candidate];
|
||||
if (candidate.indexOf(';#') >= 0) {
|
||||
parts = candidate.split(';#');
|
||||
} else if (candidate.indexOf(';') >= 0) {
|
||||
const semicolonParts: string[] = candidate.split(';');
|
||||
const allTaxonomyValues: boolean = semicolonParts.every((part: string): boolean =>
|
||||
/\|[0-9a-f]{8}-[0-9a-f-]{27}$/i.test(part.trim()));
|
||||
if (allTaxonomyValues || splitPlainSemicolon) { parts = semicolonParts; }
|
||||
}
|
||||
|
||||
const values: string[] = [];
|
||||
for (let i: number = 0; i < parts.length; i++) {
|
||||
const part: string = parts[i].trim();
|
||||
if (!part || /^-?\d+$/.test(part)) { continue; }
|
||||
const taxonomyMatch: RegExpMatchArray = part.match(/^(.*)\|[0-9a-f]{8}-[0-9a-f-]{27}$/i);
|
||||
values.push(taxonomyMatch ? taxonomyMatch[1].trim() : part);
|
||||
}
|
||||
return values.filter((text: string): boolean => !!text);
|
||||
}
|
||||
|
||||
export function replaceAccordionCategoryIds(
|
||||
values: string[],
|
||||
labelsByWssId: { [wssId: string]: string }
|
||||
): string[] {
|
||||
const result: string[] = [];
|
||||
const keys: { [key: string]: boolean } = {};
|
||||
for (let i: number = 0; i < values.length; i++) {
|
||||
const value: string = values[i];
|
||||
const label: string = /^\d+$/.test(value) && labelsByWssId[value]
|
||||
? labelsByWssId[value]
|
||||
: value;
|
||||
const key: string = '$' + label.toLocaleLowerCase();
|
||||
if (label && !keys[key]) { keys[key] = true; result.push(label); }
|
||||
}
|
||||
return result;
|
||||
}
|
||||
@@ -1,8 +1,12 @@
|
||||
import { SPHttpClient, SPHttpClientResponse } from '@microsoft/sp-http';
|
||||
import { WebPartContext } from '@microsoft/sp-webpart-base';
|
||||
import { getAccordionCategoryValues, replaceAccordionCategoryIds } from './AccordionCategoryValues';
|
||||
import { IAccordionFieldOption, IAccordionItem, IAccordionListOption } from './AccordionTypes';
|
||||
|
||||
export class AccordionDataService {
|
||||
private taxonomyLabelsByWssId: { [wssId: string]: string } = {};
|
||||
private missingTaxonomyWssIds: { [wssId: string]: boolean } = {};
|
||||
|
||||
public constructor(private context: WebPartContext) { }
|
||||
|
||||
public getLists(): Promise<IAccordionListOption[]> {
|
||||
@@ -37,7 +41,8 @@ export class AccordionDataService {
|
||||
categoryField: string,
|
||||
sortField: string,
|
||||
sortAscending: boolean,
|
||||
categoryValue: string
|
||||
categoryValue: string,
|
||||
categoryFieldType: string
|
||||
): Promise<IAccordionItem[]> {
|
||||
if (!this.isGuid(listId)) { return Promise.reject(new Error('Invalid list ID.')); }
|
||||
const fields: string[] = this.uniqueFields(['Id', titleField, contentField, categoryField]);
|
||||
@@ -45,40 +50,59 @@ export class AccordionDataService {
|
||||
if (!this.isFieldName(fields[i])) { return Promise.reject(new Error('Invalid field name.')); }
|
||||
}
|
||||
const orderField: string = this.isFieldName(sortField) ? sortField : titleField;
|
||||
const taxonomyCategory: boolean = this.isTaxonomyType(categoryFieldType) && !!categoryField;
|
||||
const formattedSelect: string = taxonomyCategory ? ',FieldValuesAsText/' + categoryField : '';
|
||||
const formattedExpand: string = taxonomyCategory ? '&$expand=FieldValuesAsText' : '';
|
||||
const url: string = this.webUrl + "/_api/web/lists(guid'" + this.cleanGuid(listId) + "')/items" +
|
||||
'?$select=' + fields.join(',') + '&$orderby=' + orderField + (sortAscending ? ' asc' : ' desc') + '&$top=5000';
|
||||
'?$select=' + fields.join(',') + formattedSelect + formattedExpand +
|
||||
'&$orderby=' + orderField + (sortAscending ? ' asc' : ' desc') + '&$top=5000';
|
||||
return this.context.spHttpClient.get(url, SPHttpClient.configurations.v1, { headers: this.headers })
|
||||
.then((response: SPHttpClientResponse): Promise<any> => this.ensureJson(response)) // tslint:disable-line:no-any
|
||||
.then((payload: any): IAccordionItem[] => this.results(payload) // tslint:disable-line:no-any
|
||||
.filter((item: any): boolean => !categoryValue || // tslint:disable-line:no-any
|
||||
this.toValues(item[categoryField]).indexOf(categoryValue) >= 0)
|
||||
.map((item: any): IAccordionItem => ({ // tslint:disable-line:no-any
|
||||
id: Number(item.Id),
|
||||
title: this.toText(item[titleField]),
|
||||
content: this.toText(item[contentField]),
|
||||
category: categoryField ? this.toText(item[categoryField]) : ''
|
||||
})));
|
||||
.then((payload: any): Promise<IAccordionItem[]> => { // tslint:disable-line:no-any
|
||||
const items: any[] = this.results(payload); // tslint:disable-line:no-any
|
||||
return this.resolveItemCategoryValues(items, categoryField, taxonomyCategory)
|
||||
.then((categoriesByItem: string[][]): IAccordionItem[] => {
|
||||
const result: IAccordionItem[] = [];
|
||||
for (let i: number = 0; i < items.length; i++) {
|
||||
const categories: string[] = categoriesByItem[i];
|
||||
if (categoryValue && categories.indexOf(categoryValue) < 0) { continue; }
|
||||
result.push({
|
||||
id: Number(items[i].Id),
|
||||
title: this.toText(items[i][titleField]),
|
||||
content: this.toText(items[i][contentField]),
|
||||
categories: categories
|
||||
});
|
||||
}
|
||||
return result;
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
public getCategoryValues(listId: string, categoryField: string): Promise<string[]> {
|
||||
public getCategoryValues(listId: string, categoryField: string, categoryFieldType: string): Promise<string[]> {
|
||||
if (!this.isGuid(listId) || !this.isFieldName(categoryField)) { return Promise.resolve([]); }
|
||||
const taxonomyCategory: boolean = this.isTaxonomyType(categoryFieldType);
|
||||
const formattedSelect: string = taxonomyCategory ? ',FieldValuesAsText/' + categoryField : '';
|
||||
const formattedExpand: string = taxonomyCategory ? '&$expand=FieldValuesAsText' : '';
|
||||
const url: string = this.webUrl + "/_api/web/lists(guid'" + this.cleanGuid(listId) + "')/items" +
|
||||
'?$select=' + categoryField + '&$top=5000';
|
||||
'?$select=' + categoryField + formattedSelect + formattedExpand + '&$top=5000';
|
||||
return this.context.spHttpClient.get(url, SPHttpClient.configurations.v1, { headers: this.headers })
|
||||
.then((response: SPHttpClientResponse): Promise<any> => this.ensureJson(response)) // tslint:disable-line:no-any
|
||||
.then((payload: any): string[] => { // tslint:disable-line:no-any
|
||||
.then((payload: any): Promise<string[]> => { // tslint:disable-line:no-any
|
||||
const items: any[] = this.results(payload); // tslint:disable-line:no-any
|
||||
return this.resolveItemCategoryValues(items, categoryField, taxonomyCategory)
|
||||
.then((categoriesByItem: string[][]): string[] => {
|
||||
const values: string[] = [];
|
||||
const keys: { [key: string]: boolean } = {};
|
||||
const items: any[] = this.results(payload); // tslint:disable-line:no-any
|
||||
for (let i: number = 0; i < items.length; i++) {
|
||||
const current: string[] = this.toValues(items[i][categoryField]);
|
||||
for (let i: number = 0; i < categoriesByItem.length; i++) {
|
||||
const current: string[] = categoriesByItem[i];
|
||||
for (let valueIndex: number = 0; valueIndex < current.length; valueIndex++) {
|
||||
const key: string = current[valueIndex].toLocaleLowerCase();
|
||||
const key: string = '$' + current[valueIndex].toLocaleLowerCase();
|
||||
if (!keys[key]) { keys[key] = true; values.push(current[valueIndex]); }
|
||||
}
|
||||
}
|
||||
return values.sort((left: string, right: string): number => left.localeCompare(right));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
private get webUrl(): string { return this.context.pageContext.web.absoluteUrl.replace(/\/$/, ''); }
|
||||
@@ -104,6 +128,72 @@ export class AccordionDataService {
|
||||
return result;
|
||||
}
|
||||
|
||||
private itemCategoryValues(item: any, categoryField: string, taxonomyCategory: boolean): string[] { // tslint:disable-line:no-any
|
||||
if (taxonomyCategory && item && item.FieldValuesAsText) {
|
||||
const formatted: string[] = getAccordionCategoryValues(
|
||||
item.FieldValuesAsText[categoryField],
|
||||
true
|
||||
);
|
||||
if (formatted.length) { return formatted; }
|
||||
}
|
||||
return getAccordionCategoryValues(item ? item[categoryField] : undefined);
|
||||
}
|
||||
|
||||
private resolveItemCategoryValues(
|
||||
items: any[], // tslint:disable-line:no-any
|
||||
categoryField: string,
|
||||
taxonomyCategory: boolean
|
||||
): Promise<string[][]> {
|
||||
const categoriesByItem: string[][] = items.map((item: any): string[] => // tslint:disable-line:no-any
|
||||
categoryField ? this.itemCategoryValues(item, categoryField, taxonomyCategory) : []);
|
||||
if (!taxonomyCategory) { return Promise.resolve(categoriesByItem); }
|
||||
|
||||
const wssIds: string[] = [];
|
||||
const seen: { [wssId: string]: boolean } = {};
|
||||
for (let itemIndex: number = 0; itemIndex < categoriesByItem.length; itemIndex++) {
|
||||
for (let valueIndex: number = 0; valueIndex < categoriesByItem[itemIndex].length; valueIndex++) {
|
||||
const value: string = categoriesByItem[itemIndex][valueIndex];
|
||||
if (/^\d+$/.test(value) && !seen[value]) { seen[value] = true; wssIds.push(value); }
|
||||
}
|
||||
}
|
||||
if (!wssIds.length) { return Promise.resolve(categoriesByItem); }
|
||||
|
||||
return this.loadTaxonomyLabels(wssIds).then((labelsByWssId: { [wssId: string]: string }): string[][] =>
|
||||
categoriesByItem.map((values: string[]): string[] => replaceAccordionCategoryIds(values, labelsByWssId)));
|
||||
}
|
||||
|
||||
private loadTaxonomyLabels(wssIds: string[]): Promise<{ [wssId: string]: string }> {
|
||||
const missingIds: string[] = wssIds.filter((wssId: string): boolean =>
|
||||
!this.taxonomyLabelsByWssId[wssId] && !this.missingTaxonomyWssIds[wssId]);
|
||||
if (!missingIds.length) { return Promise.resolve(this.taxonomyLabelsByWssId); }
|
||||
|
||||
const requests: Array<Promise<any[]>> = []; // tslint:disable-line:no-any
|
||||
for (let offset: number = 0; offset < missingIds.length; offset += 40) {
|
||||
const chunk: string[] = missingIds.slice(offset, offset + 40);
|
||||
const filter: string = chunk.map((wssId: string): string => 'Id eq ' + wssId).join(' or ');
|
||||
const url: string = this.webUrl + "/_api/site/rootweb/lists/getbytitle('TaxonomyHiddenList')/items" +
|
||||
'?$select=Id,Term&$filter=' + filter + '&$top=40';
|
||||
requests.push(this.context.spHttpClient.get(url, SPHttpClient.configurations.v1, { headers: this.headers })
|
||||
.then((response: SPHttpClientResponse): Promise<any> => this.ensureJson(response)) // tslint:disable-line:no-any
|
||||
.then((payload: any): any[] => this.results(payload))); // tslint:disable-line:no-any
|
||||
}
|
||||
|
||||
return Promise.all(requests).then((resultSets: any[][]): { [wssId: string]: string } => { // tslint:disable-line:no-any
|
||||
for (let resultIndex: number = 0; resultIndex < resultSets.length; resultIndex++) {
|
||||
const items: any[] = resultSets[resultIndex]; // tslint:disable-line:no-any
|
||||
for (let itemIndex: number = 0; itemIndex < items.length; itemIndex++) {
|
||||
const id: string = String(items[itemIndex].Id || items[itemIndex].ID || '');
|
||||
const term: string = String(items[itemIndex].Term || '').trim();
|
||||
if (id && term) { this.taxonomyLabelsByWssId[id] = term; }
|
||||
}
|
||||
}
|
||||
for (let i: number = 0; i < missingIds.length; i++) {
|
||||
if (!this.taxonomyLabelsByWssId[missingIds[i]]) { this.missingTaxonomyWssIds[missingIds[i]] = true; }
|
||||
}
|
||||
return this.taxonomyLabelsByWssId;
|
||||
});
|
||||
}
|
||||
|
||||
private toText(value: any): string { // tslint:disable-line:no-any
|
||||
if (value === undefined || value === null) { return ''; }
|
||||
if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') { return String(value); }
|
||||
@@ -113,15 +203,12 @@ export class AccordionDataService {
|
||||
return '';
|
||||
}
|
||||
|
||||
private toValues(value: any): string[] { // tslint:disable-line:no-any
|
||||
if (value === undefined || value === null) { return []; }
|
||||
const source: any[] = value && Array.isArray(value.results) ? value.results : [value]; // tslint:disable-line:no-any
|
||||
return source.map((entry: any): string => this.toText(entry).trim()) // tslint:disable-line:no-any
|
||||
.filter((entry: string): boolean => !!entry);
|
||||
}
|
||||
|
||||
private isSupportedField(type: string): boolean {
|
||||
return ['Text', 'Note', 'Choice', 'MultiChoice', 'Number', 'Integer', 'Boolean', 'DateTime', 'Computed'].indexOf(String(type)) >= 0;
|
||||
return ['Text', 'Note', 'Choice', 'MultiChoice', 'Number', 'Integer', 'Boolean', 'DateTime', 'Computed',
|
||||
'TaxonomyFieldType', 'TaxonomyFieldTypeMulti'].indexOf(String(type)) >= 0;
|
||||
}
|
||||
private isTaxonomyType(type: string): boolean {
|
||||
return type === 'TaxonomyFieldType' || type === 'TaxonomyFieldTypeMulti';
|
||||
}
|
||||
private isFieldName(value: string): boolean { return /^[A-Za-z_][A-Za-z0-9_]*$/.test(String(value || '')); }
|
||||
private isGuid(value: string): boolean { return /^[0-9a-f]{8}-[0-9a-f-]{27}$/i.test(this.cleanGuid(value)); }
|
||||
|
||||
@@ -15,6 +15,5 @@ export interface IAccordionItem {
|
||||
id: number;
|
||||
title: string;
|
||||
content: string;
|
||||
category: string;
|
||||
categories: string[];
|
||||
}
|
||||
|
||||
|
||||
@@ -16,6 +16,7 @@
|
||||
},
|
||||
"officeFabricIconFontName": "BulletedList2",
|
||||
"properties": {
|
||||
"title": "Accordion",
|
||||
"listId": "",
|
||||
"titleField": "Title",
|
||||
"contentField": "",
|
||||
|
||||
@@ -6,6 +6,7 @@ import {
|
||||
IPropertyPaneConfiguration,
|
||||
IPropertyPaneDropdownOption,
|
||||
PropertyPaneDropdown,
|
||||
PropertyPaneTextField,
|
||||
PropertyPaneToggle
|
||||
} from '@microsoft/sp-webpart-base';
|
||||
import * as strings from 'AccordionWebPartStrings';
|
||||
@@ -21,6 +22,7 @@ import {
|
||||
import styles from './components/Accordion.module.scss';
|
||||
|
||||
export interface IAccordionWebPartProps {
|
||||
title: string;
|
||||
listId: string;
|
||||
titleField: string;
|
||||
contentField: string;
|
||||
@@ -66,12 +68,14 @@ export default class AccordionWebPart extends BaseClientSideWebPart<IAccordionWe
|
||||
this.properties.categoryField || '',
|
||||
this.properties.sortField || this.properties.titleField,
|
||||
this.properties.sortAscending !== false,
|
||||
this.properties.selectedCategory || ''
|
||||
this.properties.selectedCategory || '',
|
||||
this.getFieldType(this.properties.categoryField)
|
||||
).then((items: IAccordionItem[]): void => {
|
||||
if (this.disposed || version !== this.requestVersion) { return; }
|
||||
if (!items.length) { this.renderStatus(strings.EmptyMessage, false); return; }
|
||||
const element: React.ReactElement<IAccordionProps> = React.createElement(Accordion, {
|
||||
items: items,
|
||||
title: String(this.properties.title || '').trim(),
|
||||
allowMultiple: this.properties.allowMultiple === true,
|
||||
initialState: this.normalizeInitialState(this.properties.initialState),
|
||||
showCategories: this.properties.showCategories !== false && !!this.properties.categoryField,
|
||||
@@ -126,13 +130,18 @@ export default class AccordionWebPart extends BaseClientSideWebPart<IAccordionWe
|
||||
}
|
||||
|
||||
protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
|
||||
const fieldOptions: IPropertyPaneDropdownOption[] = this.fields.map((field: IAccordionFieldOption): IPropertyPaneDropdownOption => ({
|
||||
const standardFields: IAccordionFieldOption[] = this.fields.filter((field: IAccordionFieldOption): boolean =>
|
||||
!this.isTaxonomyField(field));
|
||||
const fieldOptions: IPropertyPaneDropdownOption[] = standardFields.map((field: IAccordionFieldOption): IPropertyPaneDropdownOption => ({
|
||||
key: field.internalName, text: field.title + ' (' + field.internalName + ')'
|
||||
}));
|
||||
const categoryFieldOptions: IPropertyPaneDropdownOption[] = this.fields.map((field: IAccordionFieldOption): IPropertyPaneDropdownOption => ({
|
||||
key: field.internalName, text: field.title + ' (' + field.internalName + ')'
|
||||
}));
|
||||
const categoryOptions: IPropertyPaneDropdownOption[] = [{ key: '', text: strings.NoCategoryOption }];
|
||||
const categoryValueOptions: IPropertyPaneDropdownOption[] = [{ key: '', text: strings.AllCategoriesOption }];
|
||||
const listOptions: IPropertyPaneDropdownOption[] = [{ key: '', text: strings.SelectOption }];
|
||||
for (let i: number = 0; i < fieldOptions.length; i++) { categoryOptions.push(fieldOptions[i]); }
|
||||
for (let i: number = 0; i < categoryFieldOptions.length; i++) { categoryOptions.push(categoryFieldOptions[i]); }
|
||||
for (let i: number = 0; i < this.categories.length; i++) {
|
||||
categoryValueOptions.push({ key: this.categories[i], text: this.categories[i] });
|
||||
}
|
||||
@@ -145,6 +154,7 @@ export default class AccordionWebPart extends BaseClientSideWebPart<IAccordionWe
|
||||
groups: [{
|
||||
groupName: strings.DataGroupName,
|
||||
groupFields: [
|
||||
PropertyPaneTextField('title', { label: strings.WebPartTitleFieldLabel }),
|
||||
PropertyPaneDropdown('listId', {
|
||||
label: strings.ListFieldLabel,
|
||||
options: listOptions,
|
||||
@@ -233,7 +243,7 @@ export default class AccordionWebPart extends BaseClientSideWebPart<IAccordionWe
|
||||
}
|
||||
this.loadingCategories = true;
|
||||
this.refreshPropertyPane();
|
||||
return this.service.getCategoryValues(listId, categoryField).then((categories: string[]): void => {
|
||||
return this.service.getCategoryValues(listId, categoryField, this.getFieldType(categoryField)).then((categories: string[]): void => {
|
||||
this.categories = categories;
|
||||
if (categories.indexOf(this.properties.selectedCategory) < 0) { this.properties.selectedCategory = ''; }
|
||||
}).catch((error: Error): void => {
|
||||
@@ -247,22 +257,38 @@ export default class AccordionWebPart extends BaseClientSideWebPart<IAccordionWe
|
||||
}
|
||||
|
||||
private applyFieldDefaults(): void {
|
||||
const names: string[] = this.fields.map((field: IAccordionFieldOption): string => field.internalName);
|
||||
const standardFields: IAccordionFieldOption[] = this.fields.filter((field: IAccordionFieldOption): boolean =>
|
||||
!this.isTaxonomyField(field));
|
||||
const names: string[] = standardFields.map((field: IAccordionFieldOption): string => field.internalName);
|
||||
const categoryNames: string[] = this.fields.map((field: IAccordionFieldOption): string => field.internalName);
|
||||
if (names.indexOf(this.properties.titleField) < 0) {
|
||||
this.properties.titleField = names.indexOf('Title') >= 0 ? 'Title' : (names[0] || '');
|
||||
}
|
||||
if (names.indexOf(this.properties.contentField) < 0) {
|
||||
const note: IAccordionFieldOption = this.fields.filter((field: IAccordionFieldOption): boolean =>
|
||||
const note: IAccordionFieldOption = standardFields.filter((field: IAccordionFieldOption): boolean =>
|
||||
field.type === 'Note' && field.internalName !== this.properties.titleField)[0];
|
||||
this.properties.contentField = note ? note.internalName : this.firstDifferentField(this.properties.titleField);
|
||||
}
|
||||
if (names.indexOf(this.properties.categoryField) < 0) { this.properties.categoryField = ''; }
|
||||
if (categoryNames.indexOf(this.properties.categoryField) < 0) { this.properties.categoryField = ''; }
|
||||
if (names.indexOf(this.properties.sortField) < 0) { this.properties.sortField = this.properties.titleField; }
|
||||
}
|
||||
|
||||
private firstDifferentField(excluded: string): string {
|
||||
for (let i: number = 0; i < this.fields.length; i++) {
|
||||
if (this.fields[i].internalName !== excluded) { return this.fields[i].internalName; }
|
||||
if (this.fields[i].internalName !== excluded && !this.isTaxonomyField(this.fields[i])) {
|
||||
return this.fields[i].internalName;
|
||||
}
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
private isTaxonomyField(field: IAccordionFieldOption): boolean {
|
||||
return field.type === 'TaxonomyFieldType' || field.type === 'TaxonomyFieldTypeMulti';
|
||||
}
|
||||
|
||||
private getFieldType(internalName: string): string {
|
||||
for (let i: number = 0; i < this.fields.length; i++) {
|
||||
if (this.fields[i].internalName === internalName) { return this.fields[i].type; }
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
font-size: 14px;
|
||||
color: "[theme: neutralPrimary, default: #323130]";
|
||||
}
|
||||
.webPartHeading { font-size: 24px; font-weight: 300; line-height: 32px; margin: 0 0 14px; }
|
||||
|
||||
.category { margin: 0 0 20px; }
|
||||
.categoryTitle {
|
||||
|
||||
@@ -22,23 +22,24 @@ export default class Accordion extends React.Component<IAccordionProps, IAccordi
|
||||
|
||||
public render(): React.ReactElement<any> { // tslint:disable-line:no-any
|
||||
const groups: Array<{ name: string; items: IAccordionItem[] }> = this.groupItems();
|
||||
return <div className={styles.accordion}>
|
||||
return <section className={styles.accordion} aria-label={this.props.title}>
|
||||
{this.props.title && <h2 className={styles.webPartHeading}>{this.props.title}</h2>}
|
||||
{groups.map((group, groupIndex) =>
|
||||
<section className={styles.category} key={'group-' + groupIndex}>
|
||||
{this.props.showCategories && group.name
|
||||
? <h2 className={styles.categoryTitle}>{group.name}</h2>
|
||||
: undefined}
|
||||
<div>{group.items.map((item: IAccordionItem) => this.renderItem(item))}</div>
|
||||
<div>{group.items.map((item: IAccordionItem) => this.renderItem(item, groupIndex))}</div>
|
||||
</section>
|
||||
)}
|
||||
</div>;
|
||||
</section>;
|
||||
}
|
||||
|
||||
private renderItem(item: IAccordionItem): React.ReactElement<any> { // tslint:disable-line:no-any
|
||||
private renderItem(item: IAccordionItem, groupIndex: number): React.ReactElement<any> { // tslint:disable-line:no-any
|
||||
const open: boolean = this.state.openIds.indexOf(item.id) >= 0;
|
||||
const buttonId: string = this.instanceId + '-button-' + item.id;
|
||||
const panelId: string = this.instanceId + '-panel-' + item.id;
|
||||
return <div className={styles.item} key={item.id}>
|
||||
const buttonId: string = this.instanceId + '-button-' + groupIndex + '-' + item.id;
|
||||
const panelId: string = this.instanceId + '-panel-' + groupIndex + '-' + item.id;
|
||||
return <div className={styles.item} key={groupIndex + '-' + item.id}>
|
||||
<h3 className={styles.heading}>
|
||||
<button type='button' id={buttonId} className={styles.trigger}
|
||||
aria-expanded={open} aria-controls={panelId}
|
||||
@@ -75,12 +76,18 @@ export default class Accordion extends React.Component<IAccordionProps, IAccordi
|
||||
const result: Array<{ name: string; items: IAccordionItem[] }> = [];
|
||||
const byName: { [name: string]: { name: string; items: IAccordionItem[] } } = {};
|
||||
for (let i: number = 0; i < this.props.items.length; i++) {
|
||||
const name: string = this.props.items[i].category || this.props.defaultCategory;
|
||||
if (!byName[name]) {
|
||||
byName[name] = { name: name, items: [] };
|
||||
result.push(byName[name]);
|
||||
const names: string[] = this.props.items[i].categories.length
|
||||
? this.props.items[i].categories
|
||||
: [this.props.defaultCategory];
|
||||
for (let nameIndex: number = 0; nameIndex < names.length; nameIndex++) {
|
||||
const name: string = names[nameIndex];
|
||||
const groupKey: string = '$' + name.toLocaleLowerCase();
|
||||
if (!byName[groupKey]) {
|
||||
byName[groupKey] = { name: name, items: [] };
|
||||
result.push(byName[groupKey]);
|
||||
}
|
||||
byName[groupKey].items.push(this.props.items[i]);
|
||||
}
|
||||
byName[name].items.push(this.props.items[i]);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
@@ -2,6 +2,7 @@ import { IAccordionItem, AccordionInitialState } from '../AccordionTypes';
|
||||
|
||||
export interface IAccordionProps {
|
||||
items: IAccordionItem[];
|
||||
title: string;
|
||||
allowMultiple: boolean;
|
||||
initialState: AccordionInitialState;
|
||||
showCategories: boolean;
|
||||
@@ -9,4 +10,3 @@ export interface IAccordionProps {
|
||||
collapseLabel: string;
|
||||
defaultCategory: string;
|
||||
}
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@ define([], function() {
|
||||
"PropertyPaneDescription": "Wählen Sie die Liste und Spalten für das Akkordeon aus.",
|
||||
"DataGroupName": "Datenquelle",
|
||||
"BehaviorGroupName": "Verhalten",
|
||||
"WebPartTitleFieldLabel": "WebPart-Titel",
|
||||
"ListFieldLabel": "Liste",
|
||||
"TitleFieldLabel": "Spalte für Überschrift",
|
||||
"ContentFieldLabel": "Spalte für Inhalt",
|
||||
@@ -25,6 +26,7 @@ define([], function() {
|
||||
"LoadErrorMessage": "Die Akkordeon-Einträge konnten nicht geladen werden.",
|
||||
"ExpandLabel": "Aufklappen",
|
||||
"CollapseLabel": "Zuklappen",
|
||||
"DefaultCategory": "Weitere"
|
||||
"DefaultCategory": "Weitere",
|
||||
"DefaultTitle": "Akkordeon"
|
||||
};
|
||||
});
|
||||
|
||||
@@ -3,6 +3,7 @@ define([], function() {
|
||||
"PropertyPaneDescription": "Select the list and columns used by the accordion.",
|
||||
"DataGroupName": "Data source",
|
||||
"BehaviorGroupName": "Behavior",
|
||||
"WebPartTitleFieldLabel": "Web part title",
|
||||
"ListFieldLabel": "List",
|
||||
"TitleFieldLabel": "Heading column",
|
||||
"ContentFieldLabel": "Content column",
|
||||
@@ -25,6 +26,7 @@ define([], function() {
|
||||
"LoadErrorMessage": "The accordion entries could not be loaded.",
|
||||
"ExpandLabel": "Expand",
|
||||
"CollapseLabel": "Collapse",
|
||||
"DefaultCategory": "Other"
|
||||
"DefaultCategory": "Other",
|
||||
"DefaultTitle": "Accordion"
|
||||
};
|
||||
});
|
||||
|
||||
+2
@@ -2,6 +2,7 @@ declare interface IAccordionWebPartStrings {
|
||||
PropertyPaneDescription: string;
|
||||
DataGroupName: string;
|
||||
BehaviorGroupName: string;
|
||||
WebPartTitleFieldLabel: string;
|
||||
ListFieldLabel: string;
|
||||
TitleFieldLabel: string;
|
||||
ContentFieldLabel: string;
|
||||
@@ -25,6 +26,7 @@ declare interface IAccordionWebPartStrings {
|
||||
ExpandLabel: string;
|
||||
CollapseLabel: string;
|
||||
DefaultCategory: string;
|
||||
DefaultTitle: string;
|
||||
}
|
||||
|
||||
declare module 'AccordionWebPartStrings' {
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
import {
|
||||
getAccordionCategoryValues,
|
||||
replaceAccordionCategoryIds
|
||||
} from '../src/webparts/accordion/AccordionCategoryValues';
|
||||
|
||||
let passed: number = 0;
|
||||
function assertValues(actual: string[], expected: string[], message: string): void {
|
||||
if (actual.join('|') !== expected.join('|')) {
|
||||
throw new Error(message + ': ' + actual.join('|'));
|
||||
}
|
||||
passed++;
|
||||
}
|
||||
|
||||
const firstGuid: string = '11111111-1111-1111-1111-111111111111';
|
||||
const secondGuid: string = '22222222-2222-2222-2222-222222222222';
|
||||
|
||||
assertValues(getAccordionCategoryValues({ Label: 'Human Resources', TermGuid: firstGuid }),
|
||||
['Human Resources'], 'Single taxonomy value was not parsed.');
|
||||
assertValues(getAccordionCategoryValues({ results: [
|
||||
{ Label: 'Policies', TermGuid: firstGuid },
|
||||
{ Label: 'Benefits', TermGuid: secondGuid }
|
||||
] }), ['Policies', 'Benefits'], 'Multi-value taxonomy collection was not parsed.');
|
||||
assertValues(getAccordionCategoryValues('-1;#Policies|' + firstGuid + ';#-1;#Benefits|' + secondGuid),
|
||||
['Policies', 'Benefits'], 'Serialized SharePoint taxonomy value was not parsed.');
|
||||
assertValues(getAccordionCategoryValues('Policies|' + firstGuid + ';Benefits|' + secondGuid),
|
||||
['Policies', 'Benefits'], 'Compact serialized taxonomy value was not parsed.');
|
||||
assertValues(getAccordionCategoryValues({ results: ['General', 'General', 'News'] }),
|
||||
['General', 'News'], 'Choice values were not retained and de-duplicated.');
|
||||
assertValues(getAccordionCategoryValues('Policies; Benefits', true),
|
||||
['Policies', 'Benefits'], 'FieldValuesAsText taxonomy labels were not split.');
|
||||
assertValues(replaceAccordionCategoryIds(['1', '2'], { '1': 'Policies', '2': 'Benefits' }),
|
||||
['Policies', 'Benefits'], 'WSS IDs were not replaced with TaxonomyHiddenList labels.');
|
||||
|
||||
console.log('Accordion category value tests passed:', passed);
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "es5",
|
||||
"module": "commonjs",
|
||||
"moduleResolution": "node",
|
||||
"outDir": "../temp/tests",
|
||||
"rootDir": "..",
|
||||
"lib": ["es5", "dom"],
|
||||
"types": [],
|
||||
"skipLibCheck": true
|
||||
},
|
||||
"files": [
|
||||
"../src/webparts/accordion/AccordionCategoryValues.ts",
|
||||
"AccordionCategoryValues.test.ts"
|
||||
]
|
||||
}
|
||||
@@ -18,8 +18,8 @@ var component = read('src/webparts/accordion/components/Accordion.tsx');
|
||||
var sanitizer = read('src/webparts/accordion/AccordionHtmlSanitizer.ts');
|
||||
var styles = read('src/webparts/accordion/components/Accordion.module.scss');
|
||||
|
||||
assert(packageJson.version === '1.0.0', 'Package version must be 1.0.0.');
|
||||
assert(solution.version === '1.0.0.0', 'Solution version must be 1.0.0.0.');
|
||||
assert(packageJson.version === '1.2.1', 'Package version must be 1.2.1.');
|
||||
assert(solution.version === '1.2.1.0', 'Solution version must be 1.2.1.0.');
|
||||
assert(solution.includeClientSideAssets === true, 'Client-side assets must be included.');
|
||||
assert(solution.skipFeatureDeployment === true, 'Solution must support central deployment.');
|
||||
assert(packageJson.name === 'accordion-web-part' && solution.name === 'accordion-web-part' &&
|
||||
@@ -29,11 +29,32 @@ assert(json('config/package-solution.json').paths.zippedPackage === 'solution/ac
|
||||
assert(manifest.componentType === 'WebPart', 'Component must be a web part.');
|
||||
assert(!!config.bundles['accordion-web-part'], 'Accordion bundle is missing.');
|
||||
assert(webPart.indexOf("PropertyPaneDropdown('listId'") >= 0, 'Dynamic list selection is missing.');
|
||||
assert(webPart.indexOf("PropertyPaneTextField('title'") >= 0 &&
|
||||
component.indexOf('styles.webPartHeading') >= 0,
|
||||
'Configurable web part title is missing.');
|
||||
assert(webPart.indexOf("String(this.properties.title || '').trim()") >= 0,
|
||||
'An empty web part title must remain hidden.');
|
||||
assert(webPart.indexOf("PropertyPaneDropdown('contentField'") >= 0, 'Dynamic content field selection is missing.');
|
||||
assert(webPart.indexOf("PropertyPaneDropdown('categoryField'") >= 0, 'Category field selection is missing.');
|
||||
assert(webPart.indexOf("PropertyPaneDropdown('selectedCategory'") >= 0, 'Category value filter is missing.');
|
||||
assert(read('src/webparts/accordion/AccordionDataService.ts').indexOf('getCategoryValues') >= 0,
|
||||
'Dynamic category values are missing.');
|
||||
var dataService = read('src/webparts/accordion/AccordionDataService.ts');
|
||||
var categoryValues = read('src/webparts/accordion/AccordionCategoryValues.ts');
|
||||
assert(dataService.indexOf("'TaxonomyFieldType'") >= 0 &&
|
||||
dataService.indexOf("'TaxonomyFieldTypeMulti'") >= 0 &&
|
||||
dataService.indexOf('getAccordionCategoryValues') >= 0 &&
|
||||
categoryValues.indexOf('entry.Label') >= 0 && categoryValues.indexOf("candidate.indexOf(';#')") >= 0,
|
||||
'Managed Metadata category support is missing.');
|
||||
assert(dataService.indexOf('FieldValuesAsText/') >= 0 &&
|
||||
dataService.indexOf('itemCategoryValues') >= 0 && categoryValues.indexOf('splitPlainSemicolon') >= 0,
|
||||
'Managed Metadata labels must be resolved instead of displaying WSS IDs.');
|
||||
assert(dataService.indexOf("getbytitle('TaxonomyHiddenList')") >= 0 &&
|
||||
dataService.indexOf('loadTaxonomyLabels') >= 0 &&
|
||||
categoryValues.indexOf('replaceAccordionCategoryIds') >= 0,
|
||||
'Numeric WSS IDs must be resolved through the site collection TaxonomyHiddenList.');
|
||||
assert(component.indexOf('items[i].categories') >= 0 && component.indexOf('nameIndex') >= 0,
|
||||
'Multi-value category grouping is missing.');
|
||||
assert(component.indexOf("aria-expanded={open}") >= 0 && component.indexOf("role='region'") >= 0,
|
||||
'Accessible accordion semantics are missing.');
|
||||
assert(component.indexOf('sanitizeAccordionHtml(item.content)') >= 0, 'Rich text is not sanitized before rendering.');
|
||||
|
||||
Reference in New Issue
Block a user