[2.x] feat(core, mentions): implement ability to order groups #4350
+415
−61
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| import sortable from 'sortablejs'; | ||
|
|
||
| import app from '../../admin/app'; | ||
| import Component, { ComponentAttrs } from '../../common/Component'; | ||
| import GroupBadge from '../../common/components/GroupBadge'; | ||
| import Icon from '../../common/components/Icon'; | ||
| import EditGroupModal from './EditGroupModal'; | ||
| import sortGroups from '../../common/utils/sortGroups'; | ||
|
|
||
| import type Group from '../../common/models/Group'; | ||
| import type Mithril from 'mithril'; | ||
|
|
||
| export interface IGroupBarAttrs extends ComponentAttrs { | ||
| groups: Group[]; | ||
| } | ||
|
|
||
| /** | ||
| * A reusable component for displaying a list of groups in the admin interface, | ||
| * with the ability to edit and reorder them. | ||
| * | ||
| * @property {Group[]} groups Required. Groups to display. | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * const availableGroups = app.store | ||
| * .all<Group>('groups') | ||
| * .filter((group) => [Group.GUEST_ID, Group.MEMBER_ID].indexOf(group.id()!) === -1); | ||
| * | ||
| * <GroupBar groups={availableGroups} /> | ||
| * ``` | ||
| */ | ||
| export default class GroupBar<CustomAttrs extends IGroupBarAttrs = IGroupBarAttrs> extends Component<CustomAttrs> { | ||
| groups: Group[] = []; | ||
|
|
||
| oninit(vnode: Mithril.Vnode<CustomAttrs, this>) { | ||
| super.oninit(vnode); | ||
|
|
||
| this.groups = sortGroups(this.attrs.groups); | ||
| } | ||
|
|
||
| onupdate(vnode: Mithril.VnodeDOM<CustomAttrs, this>) { | ||
| super.onupdate(vnode); | ||
| this.groups = sortGroups(this.attrs.groups); | ||
| } | ||
|
|
||
| view(): JSX.Element { | ||
| return ( | ||
| <div className="GroupBar" oncreate={this.onGroupBarCreate.bind(this)}> | ||
| {this.groups.map((group) => ( | ||
| <button className="Button Group" type="button" data-id={group.id()} onclick={() => app.modal.show(EditGroupModal, { group })}> | ||
| <GroupBadge group={group} className="Group-icon" label={null} /> | ||
| <span className="Group-name">{group.namePlural()}</span> | ||
| </button> | ||
| ))} | ||
| <button className="Button Group Group--add" type="button" onclick={() => app.modal.show(EditGroupModal)}> | ||
| <Icon name="fas fa-plus" className="Group-icon" /> | ||
| <span className="Group-name">{app.translator.trans('core.admin.permissions.new_group_button')}</span> | ||
| </button> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| onGroupBarCreate(vnode: Mithril.VnodeDOM) { | ||
| sortable.create(vnode.dom as HTMLElement, { | ||
| group: 'groups', | ||
| delay: 50, | ||
| delayOnTouchOnly: true, | ||
| touchStartThreshold: 5, | ||
| animation: 150, | ||
| swapThreshold: 0.65, | ||
| dragClass: 'Group-Sortable-Dragging', | ||
| ghostClass: 'Group-Sortable-Placeholder', | ||
|
|
||
| filter: '.Group--add', | ||
| onMove: (evt) => !evt.related.classList.contains('Group--add'), | ||
DavideIadeluca marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| onSort: () => this.onSortUpdate(), | ||
| }); | ||
| } | ||
|
|
||
| onSortUpdate() { | ||
| const order = this.$('.Group:not(.Group--add)') | ||
| .map(function () { | ||
| return $(this).data('id'); | ||
| }) | ||
| .get(); | ||
|
|
||
| order.forEach((id, i) => { | ||
| app.store.getById<Group>('groups', id)?.pushData({ | ||
| attributes: { position: i }, | ||
| }); | ||
| }); | ||
|
Member
There was a problem hiding this comment.
At minimum, revert the store positions on failure: const previousPositions = order.map((id, i) => ({
id,
position: app.store.getById<Group>("groups", id)?.position() ?? null,
}));
app.request({ ... }).catch(() => {
previousPositions.forEach(({ id, position }) => {
app.store.getById<Group>("groups", id)?.pushData({ attributes: { position } });
});
m.redraw();
});
Contributor
Author
There was a problem hiding this comment.
This is not quite correct. This is the same behaviour as for when ordering Tags or other implementations of |
||
|
|
||
| app.request({ | ||
| url: app.forum.attribute('apiUrl') + '/groups/order', | ||
| method: 'POST', | ||
| body: { order }, | ||
| }); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| import type Group from '../models/Group'; | ||
|
|
||
| export default function sortGroups(groups: Group[]) { | ||
| return groups.slice().sort((a, b) => { | ||
| const aPos = a.position(); | ||
| const bPos = b.position(); | ||
|
|
||
| if (aPos === null && bPos === null) return 0; | ||
| if (aPos === null) return 1; | ||
| if (bPos === null) return -1; | ||
|
|
||
| return aPos - bPos; | ||
| }); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of Flarum. | ||
| * | ||
| * For detailed copyright and license information, please view the | ||
| * LICENSE file that was distributed with this source code. | ||
| */ | ||
|
|
||
| use Illuminate\Database\Schema\Blueprint; | ||
| use Illuminate\Database\Schema\Builder; | ||
|
|
||
| return [ | ||
| 'up' => function (Builder $schema) { | ||
| $schema->table('groups', function (Blueprint $table) { | ||
| $table->integer('position')->after('is_hidden')->nullable(); | ||
| }); | ||
|
|
||
| $db = $schema->getConnection(); | ||
|
|
||
| $ids = $db->table('groups') | ||
| ->orderBy('id') | ||
| ->pluck('id'); | ||
|
|
||
| $position = 0; | ||
| foreach ($ids as $id) { | ||
| $db->table('groups') | ||
| ->where('id', $id) | ||
| ->update(['position' => $position]); | ||
|
|
||
| $position++; | ||
| } | ||
| }, | ||
|
|
||
| 'down' => function (Builder $schema) { | ||
| $schema->table('groups', function (Blueprint $table) { | ||
| $table->dropColumn('position'); | ||
| }); | ||
| } | ||
| ]; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.