Refactor Vue components using Composition API #230

- Migrate `StatefulVue`:
  - Introduce `UseCollectionState` that replaces its behavior and acts
    as a shared state store.
  - Add more encapsulated, granular functions based on read or write
    access to state in CollectionState.
- Some linting rules get activates due to new code-base compability to
  modern parses, fix linting errors.
  - Rename Dialog to ModalDialog as after refactoring,
    eslintvue/no-reserved-component-names does not allow name Dialog.
  - To comply with `vue/multi-word-component-names`, rename:
    - `Code`          -> `CodeInstruction`
    - `Handle`        -> `SliderHandle`
    - `Documentable`  -> `DocumentableNode`
    - `Node`          -> `NodeContent`
    - `INode`         -> `INodeContent`
    - `Responsive`    -> `SizeObserver`
- Remove `vue-property-decorator` and `vue-class-component`
  dependencies.
- Refactor `watch` with computed properties when possible for cleaner
  code.
  - Introduce `UseApplication` to reduce repeated code in new components
    that use `computed` more heavily than before.
- Change TypeScript target to `es2017` to allow top level async calls
  for getting application context/state/instance to simplify the code by
  removing async calls. However, mocha (unit and integration) tests do
  not run with top level awaits, so a workaround is used.
This commit is contained in:
undergroundwires
2023-08-07 13:16:39 +02:00
parent 3a594ac7fd
commit 1b9be8fe2d
67 changed files with 2135 additions and 1267 deletions

View File

@@ -3,7 +3,7 @@
<input
type="search"
class="search-term"
:placeholder="searchPlaceHolder"
:placeholder="searchPlaceholder"
v-model="searchQuery"
>
<div class="icon-wrapper">
@@ -13,53 +13,75 @@
</template>
<script lang="ts">
import { Component, Watch } from 'vue-property-decorator';
import { StatefulVue } from '@/presentation/components/Shared/StatefulVue';
import {
defineComponent, ref, watch, computed,
} from 'vue';
import { useCollectionState } from '@/presentation/components/Shared/Hooks/UseCollectionState';
import { NonCollapsing } from '@/presentation/components/Scripts/View/Cards/NonCollapsingDirective';
import { IReadOnlyUserFilter } from '@/application/Context/State/Filter/IUserFilter';
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
import { IReadOnlyCategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
@Component({
directives: { NonCollapsing },
})
export default class TheSearchBar extends StatefulVue {
public searchPlaceHolder = 'Search';
export default defineComponent({
directives: {
NonCollapsing,
},
setup() {
const {
modifyCurrentState, onStateChange, events, currentState,
} = useCollectionState();
public searchQuery = '';
const searchPlaceholder = computed<string>(() => {
const { totalScripts } = currentState.value.collection;
return `Search in ${totalScripts} scripts`;
});
const searchQuery = ref<string>();
@Watch('searchQuery')
public async updateFilter(newFilter?: string) {
const context = await this.getCurrentContext();
const { filter } = context.state;
if (!newFilter) {
filter.removeFilter();
} else {
filter.setFilter(newFilter);
watch(searchQuery, (newFilter) => updateFilter(newFilter));
function updateFilter(newFilter: string) {
modifyCurrentState((state) => {
const { filter } = state;
if (!newFilter) {
filter.removeFilter();
} else {
filter.setFilter(newFilter);
}
});
}
}
protected handleCollectionState(newState: IReadOnlyCategoryCollectionState) {
const { totalScripts } = newState.collection;
this.searchPlaceHolder = `Search in ${totalScripts} scripts`;
this.searchQuery = newState.filter.currentFilter ? newState.filter.currentFilter.query : '';
this.events.unsubscribeAll();
this.subscribeFilter(newState.filter);
}
onStateChange((newState) => {
events.unsubscribeAll();
subscribeSearchQuery(newState);
}, { immediate: true });
private subscribeFilter(filter: IReadOnlyUserFilter) {
this.events.register(filter.filtered.on((result) => this.handleFiltered(result)));
this.events.register(filter.filterRemoved.on(() => this.handleFilterRemoved()));
}
function subscribeSearchQuery(newState: IReadOnlyCategoryCollectionState) {
searchQuery.value = newState.filter.currentFilter ? newState.filter.currentFilter.query : '';
subscribeFilter(newState.filter);
}
private handleFiltered(result: IFilterResult) {
this.searchQuery = result.query;
}
function subscribeFilter(filter: IReadOnlyUserFilter) {
events.register(
filter.filtered.on((result) => handleFiltered(result)),
filter.filterRemoved.on(() => handleFilterRemoved()),
);
}
function handleFilterRemoved() {
searchQuery.value = '';
}
function handleFiltered(result: IFilterResult) {
searchQuery.value = result.query;
}
return {
searchPlaceholder,
searchQuery,
};
},
});
private handleFilterRemoved() {
this.searchQuery = '';
}
}
</script>
<style scoped lang="scss">