Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

10.4 KB
Raw Blame
<template>
  <form @submit.prevent="searchSubmitted" :class="minimalSearch ? 'minimal' : 'normal'">
    <label for="filter-tiles">{{ $t('search.search-label') }}</label>
    <div class="search-wrap">
      <input
        id="filter-tiles"
        :value="input"
        ref="filter"
        role="searchbox"
        :aria-label="$t('search.search-label')"
        aria-keyshortcuts="Enter Escape"
        :placeholder="$t('search.search-placeholder')"
        v-on:input="userIsTypingSomething"
        @keydown.esc="clearFilterInput" />
        <p v-if="searchNote && input.length > 0" class="web-search-note">
          {{ searchNote }}
        </p>
      </div>
      <i v-if="input.length > 0"
        class="clear-search"
        :title="$t('search.clear-search-tooltip')"
        @click="clearFilterInput">x</i>
  </form>
</template>

<script>
import router from '@/router';
import ArrowKeyNavigation from '@/utils/ArrowKeyNavigation';
import ErrorHandler from '@/utils/logging/ErrorHandler';
import { getCustomKeyShortcuts, makeWorkspaceRoute } from '@/utils/config/ConfigHelpers';
import {
  getSearchEngineFromBang, findUrlForSearchEngine, stripBangs, isUrlLike,
} from '@/utils/Search';
import {
  searchEngineUrls,
  defaultSearchEngine,
  defaultSearchOpeningMethod,
  searchBangs as defaultSearchBangs,
} from '@/utils/config/defaults';

export default {
  name: 'FilterTile',
  props: {
    minimalSearch: Boolean, // If true, then keep it simple
  },
  emits: ['user-is-searchin'],
  data() {
    return {
      input: '', // Users current search term
      akn: new ArrowKeyNavigation(), // Class that manages arrow key naviagtion
      getCustomKeyShortcuts,
      emitFrame: null, // Pending requestAnimationFrame id, for coalescing keystrokes
    };
  },
  computed: {
    active() {
      return !this.$store.state.modalOpen;
    },
    searchPrefs() {
      return this.$store.getters.webSearch || {};
    },
    urlDetected() {
      return this.searchPrefs.openUrlsDirectly && isUrlLike(this.input);
    },
    searchNote() {
      if (this.urlDetected) return this.$t('search.enter-to-open-url');
      if (this.searchPrefs.disableWebSearch) return this.$t('search.enter-to-launch-first');
      return this.$t('search.enter-to-search-web');
    },
  },
  mounted() {
    window.addEventListener('keydown', this.handleKeyPress);
  },
  beforeUnmount() {
    window.removeEventListener('keydown', this.handleKeyPress);
    if (this.emitFrame != null) cancelAnimationFrame(this.emitFrame);
  },
  methods: {
    /* Route global keystrokes to search / hotkeys / nav
     * Bails out for modifier combos, and keystrokes on already focused inputs */
    handleKeyPress(event) {
      if (!this.active || event.ctrlKey || event.metaKey || event.altKey) return;
      const target = event.target;
      const inFilter = target?.id === 'filter-tiles';
      const inOtherEditable = !inFilter && target && (
        /^(INPUT|TEXTAREA|SELECT)$/.test(target.tagName) || target.isContentEditable
      );
      if (inOtherEditable) return;
      const { key, keyCode } = event;
      // Letter or bang key pressed - start searching
      if (/^([/:!]|\p{L})$/u.test(key) && !inFilter) {
        this.$refs.filter?.focus();
        this.userIsTypingSomething();
      } else if (/^[0-9]$/.test(key)) {
        // Digit: fire bound hotkey if one exists
        if (this.handleHotKey(key)) return;
        if (!inFilter) {
          this.$refs.filter?.focus();
          this.userIsTypingSomething();
        }
      } else if (keyCode >= 37 && keyCode <= 40) {
      // Arrow key pressed - start navigation
        this.akn.arrowNavigation(keyCode);
      } else if (keyCode === 27) {
      // Esc key pressed - reset form
        this.clearFilterInput();
      }
    },
    /* Emmits users's search term up to parent */
    userIsTypingSomething(event) {
      if (event) this.input = event.target.value;
      if (this.emitFrame != null) return;
      this.emitFrame = requestAnimationFrame(() => {
        this.emitFrame = null;
        this.$emit('user-is-searchin', this.input);
      });
    },
    /* Resets everything to initial state, when user is finished */
    clearFilterInput() {
      this.input = '';
      if (this.emitFrame != null) {
        cancelAnimationFrame(this.emitFrame);
        this.emitFrame = null;
      }
      this.$emit('user-is-searchin', '');
      this.$refs.filter?.blur();
      this.akn.resetIndex();
    },
    /* Launch the app bound to the pressed digit, if one is configured.
     * Returns true when a hotkey fired, so the caller can fall through to
     * normal search-bar focus when no binding exists. */
    handleHotKey(key) {
      const sections = this.$store.getters.sections || [];
      const match = this.getCustomKeyShortcuts(sections)
        .find((h) => h.hotkey === parseInt(key, 10));
      if (!match?.url) return false;
      window.open(match.url, '_blank');
      return true;
    },
    /* Launch search results, with users desired opening method */
    launchWebSearch(url, method) {
      switch (method) {
        case 'newtab':
          window.open(url, '_blank');
          break;
        case 'sametab':
          window.open(url, '_self');
          break;
        case 'workspace':
          router.push(makeWorkspaceRoute(url, this.$store));
          break;
        default:
          ErrorHandler(`Unknown opening method: ${method}`);
          window.open(url, '_blank');
      }
    },

    /* Launches the first result (only used when disableWebSearch: true) */
    openFirstResult() {
      const first = document.querySelector('.item:not(.add-new)');
      if (!first) return;
      first.click();
      this.clearFilterInput();
    },

    /* Launch web search, to correct search engine, passing in users query */
    searchSubmitted() {
      const { searchPrefs } = this;
      const input = this.input.trim();
      if (!input) return;
      if (searchPrefs.disableWebSearch) {
        this.openFirstResult();
        return;
      }
      const openingMethod = searchPrefs.openingMethod || defaultSearchOpeningMethod;
      // If openUrlsDirectly enabled and input looks like a URL, navigate directly
      if (searchPrefs.openUrlsDirectly && isUrlLike(input)) {
        const url = /^https?:\/\//.test(input) ? input : `https://${input}`;
        this.launchWebSearch(url, openingMethod);
        this.clearFilterInput();
        return;
      }
      const bangList = { ...defaultSearchBangs, ...(searchPrefs.searchBangs || {}) };
      const searchBang = getSearchEngineFromBang(this.input, bangList);
      const searchEngine = searchPrefs.searchEngine || defaultSearchEngine;
      // Use either search bang, or preffered search engine
      const desiredSearchEngine = searchBang || searchEngine;
      const isCustomSearch = !searchBang
        && searchPrefs.searchEngine === 'custom' && searchPrefs.customSearchEngine;
      let searchUrl = isCustomSearch
        ? searchPrefs.customSearchEngine
        : findUrlForSearchEngine(desiredSearchEngine, searchEngineUrls);
      if (searchUrl) { // Append search query to URL, and launch
        searchUrl += encodeURIComponent(stripBangs(this.input, bangList));
        this.launchWebSearch(searchUrl, openingMethod);
        this.clearFilterInput();
      }
    },
  },
};
</script>

<style scoped lang="scss">

@import '@/styles/media-queries.scss';

  form.normal {
    display: flex;
    align-items: baseline;
    border-radius: 0 0 var(--curve-factor-navbar) 0;
    padding: 0 0.2rem 0.2rem 0;
    background: var(--search-container-background);
    .search-wrap {
      display: flex;
      flex-direction: column;
      width: 100%;
      p.web-search-note {
        margin: 0 0.5rem;
        font-size: 0.8rem;
        color: var(--minimal-view-search-color);
        opacity: var(--dimming-factor);
      }
    }
    label {
        display: inline;
        color: var(--search-label-color);
        margin: 0.5rem;
        display: inline;
        word-break: keep-all;
    }
    input {
      display: inline-block;
      width: 200px;
      height: 1rem;
      padding: 0.5rem;
      margin: 0.5rem;
      outline: none;
      border: none;
      border-radius: var(--curve-factor);
      background: var(--search-field-background);
      color: var(--settings-text-color);
      border: 1px solid var(--outline-color);
      &:focus {
        border-color: var(--settings-text-color);
        opacity: var(--dimming-factor);
      }
    }
    .clear-search {
      color: var(--settings-text-color);
      padding: 0 0.3rem 0.1rem 0.3rem;
      font-style: normal;
      font-size: 1rem;
      opacity: var(--dimming-factor);
      border-radius: 50px;
      cursor: pointer;
      right: 0.5rem;
      top: 1rem;
      border: 1px solid var(--settings-text-color);
      margin: 0.25rem;
      &:hover {
        opacity: 1;
        background: var(--background-darker);
      }
    }
  }

  @include tablet {
    form.normal {
      display: block;
      text-align: center;
    }
  }
  @include phone {
    form.nomral {
      flex: 1;
      border-radius: 0;
      text-align: center;
      padding: 0.25rem 0;
      display: block;
    }
  }

  form.minimal {
    display: flex;
    align-items: center;
    label { display: none; }
    .search-wrap {
      display: flex;
      flex-direction: column;
      align-items: center;
      width: 100%;
      p.web-search-note {
        margin: 0;
        color: var(--minimal-view-search-color);
        opacity: var(--dimming-factor);
      }
    }
    input {
      display: inline-block;
      width: 80%;
      max-width: 400px;
      font-size: 1.2rem;
      padding: 0.5rem 1rem;
      margin: 1rem auto;
      outline: none;
      border: 1px solid var(--outline-color);
      border-radius: var(--curve-factor);
      background: var(--minimal-view-search-background);
      color: var(--minimal-view-search-color);
      &:focus {
        border-color: var(--minimal-view-search-color);
        opacity: var(--dimming-factor);
      }
    }
    .clear-search {
      color: var(--minimal-view-search-color);
      padding: 0.15rem 0.5rem 0.2rem 0.5rem;
      font-style: normal;
      font-size: 1rem;
      opacity: var(--dimming-factor);
      border-radius: 50px;
      cursor: pointer;
      right: 0.5rem;
      top: 1rem;
      border: 1px solid var(--minimal-view-search-color);
      margin: 0.5rem;
      &:hover {
        opacity: 1;
        color: var(--minimal-view-search-background);
        background: var(--minimal-view-search-color);
      }
    }
  }
</style>