No documentation for scrollAssist, autoFocusAssist, inputBlurring config settings

Alexmady · 2017-05-01 08:31:21 UTC

I can’t seem to find documentation for these at https://ionicframework.com/docs/api/config/Config/

platforms: {
                ios: {
                    scrollAssist: false, 
                    autoFocusAssist: false,
                    inputBlurring: false, 
                }
            }

Alexmady · 2017-05-01 14:14:44 UTC

UPDATE: there is no documentation whatsoever about these options, however they do seem to have important effects, especially with ionic 3

Sujan12 · 2017-05-01 21:10:55 UTC

Short dive into the code:

scrollAssist:

github.com

ionic-team/ionic/blob/41e34fc4ce08444330d0c7781c367dce1e6ee0a1/src/components/input/input.ts

import { Component, Optional, ElementRef, EventEmitter, Input, Output, Renderer, ViewChild, ViewEncapsulation } from '@angular/core';
import { NgControl } from '@angular/forms';

import { App } from '../app/app';
import { Config } from '../../config/config';
import { Content, ContentDimensions, ScrollEvent } from '../content/content';
import { copyInputAttributes, PointerCoordinates, hasPointerMoved, pointerCoord }  from '../../util/dom';
import { DomController } from '../../platform/dom-controller';
import { Form, IonicFormInput } from '../../util/form';
import { Ion } from '../ion';
import { isString, isTrueProperty } from '../../util/util';
import { Item } from '../item/item';
import { NativeInput } from './native-input';
import { NextInput } from './next-input';
import { NavController } from '../../navigation/nav-controller';
import { NavControllerBase } from '../../navigation/nav-controller-base';
import { Platform } from '../../platform/platform';


/**

This file has been truncated. show original

github.com

ionic-team/ionic/blob/41e34fc4ce08444330d0c7781c367dce1e6ee0a1/src/components/input/input.ts

import { Component, Optional, ElementRef, EventEmitter, Input, Output, Renderer, ViewChild, ViewEncapsulation } from '@angular/core';
import { NgControl } from '@angular/forms';

import { App } from '../app/app';
import { Config } from '../../config/config';
import { Content, ContentDimensions, ScrollEvent } from '../content/content';
import { copyInputAttributes, PointerCoordinates, hasPointerMoved, pointerCoord }  from '../../util/dom';
import { DomController } from '../../platform/dom-controller';
import { Form, IonicFormInput } from '../../util/form';
import { Ion } from '../ion';
import { isString, isTrueProperty } from '../../util/util';
import { Item } from '../item/item';
import { NativeInput } from './native-input';
import { NextInput } from './next-input';
import { NavController } from '../../navigation/nav-controller';
import { NavControllerBase } from '../../navigation/nav-controller-base';
import { Platform } from '../../platform/platform';


/**

This file has been truncated. show original

github.com

ionic-team/ionic/blob/41e34fc4ce08444330d0c7781c367dce1e6ee0a1/src/components/input/input.ts

import { Component, Optional, ElementRef, EventEmitter, Input, Output, Renderer, ViewChild, ViewEncapsulation } from '@angular/core';
import { NgControl } from '@angular/forms';

import { App } from '../app/app';
import { Config } from '../../config/config';
import { Content, ContentDimensions, ScrollEvent } from '../content/content';
import { copyInputAttributes, PointerCoordinates, hasPointerMoved, pointerCoord }  from '../../util/dom';
import { DomController } from '../../platform/dom-controller';
import { Form, IonicFormInput } from '../../util/form';
import { Ion } from '../ion';
import { isString, isTrueProperty } from '../../util/util';
import { Item } from '../item/item';
import { NativeInput } from './native-input';
import { NextInput } from './next-input';
import { NavController } from '../../navigation/nav-controller';
import { NavControllerBase } from '../../navigation/nav-controller-base';
import { Platform } from '../../platform/platform';


/**

This file has been truncated. show original

(I don’t understand how this works and what this changes)

autoFocusAssist:

github.com

ionic-team/ionic/blob/41e34fc4ce08444330d0c7781c367dce1e6ee0a1/src/components/input/input.ts

import { Component, Optional, ElementRef, EventEmitter, Input, Output, Renderer, ViewChild, ViewEncapsulation } from '@angular/core';
import { NgControl } from '@angular/forms';

import { App } from '../app/app';
import { Config } from '../../config/config';
import { Content, ContentDimensions, ScrollEvent } from '../content/content';
import { copyInputAttributes, PointerCoordinates, hasPointerMoved, pointerCoord }  from '../../util/dom';
import { DomController } from '../../platform/dom-controller';
import { Form, IonicFormInput } from '../../util/form';
import { Ion } from '../ion';
import { isString, isTrueProperty } from '../../util/util';
import { Item } from '../item/item';
import { NativeInput } from './native-input';
import { NextInput } from './next-input';
import { NavController } from '../../navigation/nav-controller';
import { NavControllerBase } from '../../navigation/nav-controller-base';
import { Platform } from '../../platform/platform';


/**

This file has been truncated. show original

github.com

ionic-team/ionic/blob/41e34fc4ce08444330d0c7781c367dce1e6ee0a1/src/components/input/input.ts

import { Component, Optional, ElementRef, EventEmitter, Input, Output, Renderer, ViewChild, ViewEncapsulation } from '@angular/core';
import { NgControl } from '@angular/forms';

import { App } from '../app/app';
import { Config } from '../../config/config';
import { Content, ContentDimensions, ScrollEvent } from '../content/content';
import { copyInputAttributes, PointerCoordinates, hasPointerMoved, pointerCoord }  from '../../util/dom';
import { DomController } from '../../platform/dom-controller';
import { Form, IonicFormInput } from '../../util/form';
import { Ion } from '../ion';
import { isString, isTrueProperty } from '../../util/util';
import { Item } from '../item/item';
import { NativeInput } from './native-input';
import { NextInput } from './next-input';
import { NavController } from '../../navigation/nav-controller';
import { NavControllerBase } from '../../navigation/nav-controller-base';
import { Platform } from '../../platform/platform';


/**

This file has been truncated. show original

inputBlurring:

github.com

ionic-team/ionic/blob/63fd63e72e8cf44767ec8ca2d6ba0e6b9f071317/src/components/input/native-input.ts

import { Directive, ElementRef, EventEmitter, HostListener, Output, Renderer } from '@angular/core';
import { NgControl } from '@angular/forms';

import { Config } from '../../config/config';
import { Platform } from '../../platform/platform';


/**
 * @hidden
 */
@Directive({
  selector: '.text-input'
})
export class NativeInput {
  _relocated: boolean;
  _clone: boolean;
  _blurring: boolean;
  _unrefBlur: Function;

  @Output() focusChange: EventEmitter<boolean> = new EventEmitter<boolean>();

This file has been truncated. show original

github.com

ionic-team/ionic/blob/63fd63e72e8cf44767ec8ca2d6ba0e6b9f071317/src/components/input/native-input.ts

import { Directive, ElementRef, EventEmitter, HostListener, Output, Renderer } from '@angular/core';
import { NgControl } from '@angular/forms';

import { Config } from '../../config/config';
import { Platform } from '../../platform/platform';


/**
 * @hidden
 */
@Directive({
  selector: '.text-input'
})
export class NativeInput {
  _relocated: boolean;
  _clone: boolean;
  _blurring: boolean;
  _unrefBlur: Function;

  @Output() focusChange: EventEmitter<boolean> = new EventEmitter<boolean>();

This file has been truncated. show original

RohinMohandas · 2017-05-10 13:43:46 UTC

It would be really useful having documentation on these config settings, especially since the keyboard issues are planned only for milestone 3.2.0

Sujan12 · 2017-05-10 14:05:18 UTC

3 ways to solve this:

Comment on that issue, add this thread here.
Open another issue that mentions this missing documentation.
Write the documentation yourself in the repository and submit a PR.