opensourcemirror
/
oni
mirror of https://github.com/onivim/oni.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Bugfix - Sneak: Don't show sneak hints for elements outside the window view (#1884) 

* Filter out sneaks that are outside of the viewport

* Filter sneak rectangles

* Fix regression in building the browser hook

* Don't add invisible elements to sneak in the browser window

* Update test with case for filtering
This commit is contained in:
Bryan Phelps 2018-03-22 18:16:11 -07:00 committed by GitHub
parent aed42715f3
commit 88dd767c39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 125 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
browser/src/Services/Sneak/Sneak.tsx
View File

@ -42,7 +42,11 @@ export class Sneak {
this._activeOverlay = null
}
this._store.dispatch({ type: "START" })
this._store.dispatch({
type: "START",
width: document.body.offsetWidth,
height: document.body.offsetHeight,
})
this._collectSneakRectangles()
this._activeOverlay = this._overlayManager.createItem()

19
browser/src/Services/Sneak/SneakStore.ts
View File

@ -22,16 +22,22 @@ export interface IAugmentedSneakInfo extends ISneakInfo {
export interface ISneakState {
isActive: boolean
sneaks: IAugmentedSneakInfo[]
width: number
height: number
}
const DefaultSneakState: ISneakState = {
isActive: true,
sneaks: [],
width: 0,
height: 0,
}
export type SneakAction =
| {
type: "START"
width: number
height: number
}
| {
type: "END"
@ -47,7 +53,11 @@ export const sneakReducer: Reducer<ISneakState> = (
) => {
switch (action.type) {
case "START":
return DefaultSneakState
return {
...DefaultSneakState,
width: action.width,
height: action.height,
}
case "END":
return {
...DefaultSneakState,
@ -58,7 +68,12 @@ export const sneakReducer: Reducer<ISneakState> = (
return state
}
const newSneaks: IAugmentedSneakInfo[] = action.sneaks.map((sneak, idx) => {
const filteredSneaks = action.sneaks.filter(sneak => {
const { x, y } = sneak.rectangle
return x >= 0 && y >= 0 && x < state.width && y < state.height
})
const newSneaks: IAugmentedSneakInfo[] = filteredSneaks.map((sneak, idx) => {
return {
...sneak,
triggerKeys: getLabelFromIndex(idx + state.sneaks.length),

31
browser/test/Services/Sneak/SneakStoreTests.ts
View File

@ -4,9 +4,15 @@ import * as Oni from "oni-api"
import { createStore, ISneakInfo } from "./../../../src/Services/Sneak/SneakStore"
const createTestSneak = (callback: () => void): ISneakInfo => {
const createTestSneak = (
callback: () => void,
x: number = 1,
y: number = 1,
width: number = 10,
height: number = 10,
): ISneakInfo => {
return {
rectangle: Oni.Shapes.Rectangle.create(0, 0, 0, 0),
rectangle: Oni.Shapes.Rectangle.create(x, y, width, height),
callback,
}
}
@ -36,7 +42,7 @@ describe("SneakStore", () => {
const sneaksRound1 = [createTestSneak(null), createTestSneak(null)]
store.dispatch({ type: "START" })
store.dispatch({ type: "START", width: 100, height: 100 })
store.dispatch({
type: "ADD_SNEAKS",
sneaks: sneaksRound1,
@ -53,4 +59,23 @@ describe("SneakStore", () => {
assert.deepEqual(keys, ["AA", "AB", "AC", "AD"])
})
it("ADD_SNEAKS that are offscreen are not added", () => {
const store = createStore()
const normalSneak = createTestSneak(null, 2, 2, 10, 10)
const offscreenSneak = createTestSneak(null, 101, 101, 10, 10)
const sneaksRound1 = [normalSneak, offscreenSneak]
store.dispatch({ type: "START", width: 100, height: 100 })
store.dispatch({
type: "ADD_SNEAKS",
sneaks: sneaksRound1,
})
const state = store.getState()
assert.strictEqual(state.sneaks.length, 1, "Validate only one sneak was added")
assert.strictEqual(state.sneaks[0].rectangle.x, 2, "Validate the correct sneak was added")
})
})

19
webview_preload/src/index.ts
View File

@ -35,14 +35,33 @@
_tags = []
let idx = 0
const width = window.innerWidth
const height = window.innerHeight
const addElement = (element: HTMLElement): void => {
idx++
const clientRect = element.getBoundingClientRect()
if (clientRect.width === 0 || clientRect.height === 0) {
return
}
const isInBounds =
clientRect.top >= 0 &&
clientRect.left >= 0 &&
clientRect.top <= height &&
clientRect.left <= width
if (!isInBounds) {
return
}
const callback = (elem: HTMLElement) => () => {
if (elem && elem.click) {
elem.click()
}
}
_tags.push({
rectangle: createRectangle(
clientRect.left,

82
webview_preload/tsconfig.json
View File

@ -1,31 +1,61 @@
{
"compilerOptions": {
"allowUnreachableCode": false,
"allowUnusedLabels": false,
"experimentalDecorators": true,
"forceConsistentCasingInFileNames": true,
"jsx": "react",
"lib": ["dom", "es2017"],
"module": "esnext",
"moduleResolution": "node",
"newLine": "LF",
"noEmitOnError": true,
"noFallthroughCasesInSwitch": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"noUnusedLocals": true,
"outDir": "../lib_test/browser",
"pretty": true,
"removeComments": true,
"rootDir": ".",
"skipLibCheck": true,
"strictNullChecks": false,
"suppressImplicitAnyIndexErrors": true,
"target": "es2015",
"sourceMap": true,
/* Basic Options */
"target":
"es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */,
"module":
"commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
"outDir": "../lib/webview_preload",
// "lib": [], /* Specify library files to be included in the compilation: */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true /* Enable all strict type-checking options. */,
"types": ["mocha"]
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
/* Source Map Options */
// "sourceRoot": "./", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "./", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
},
"include": ["src/**/*.ts", "test/**/*.ts", "src/**/*.tsx"],
"exclude": ["node_modules", "**/*.test.tsx", "ui-tests"]
"include": ["src/**/*.ts"],
"exclude": ["node_modules"]
}