feat(ios): apple intelligence writing tools (NativeScript#10643)

Author: NathanWalker

apps/automated/project.json

@@ -24,6 +24,7 @@
 			"executor": "@nativescript/nx:debug",
 			"options": {
 				"noHmr": true,
+				"debug": false,
 				"uglify": false,
 				"release": false,
 				"forDevice": false,

apps/toolbox/src/pages/forms.ts

@@ -1,4 +1,4 @@
-import { Page, Observable, EventData, TextField, PropertyChangeData } from '@nativescript/core';
+import { Page, Observable, EventData, TextField, PropertyChangeData, TextView } from '@nativescript/core';
 
 let page: Page;
 
@@ -28,6 +28,12 @@ export class SampleData extends Observable {
 		console.log(args.value);
 		this.notifyPropertyChange('formattedPhoneInput', args.value);
 	}
+
+	textChangeArea(args: PropertyChangeData) {
+		const textArea = args.object as TextView;
+		console.log('---- AI active:', textArea.isWritingToolsActive);
+		console.log('textChangeArea:', args.value);
+	}
 }
 
 function formatPhoneNumber(value: string, useParens?: boolean) {

apps/toolbox/src/pages/forms.xml

@@ -20,6 +20,10 @@
       </TextField>
       <Label text="{{ formattedPhoneInput }}" marginTop="6" />
 
+      <Label text="TextView" fontWeight="bold" marginTop="12" />
+      <TextView hint="Type text..." style.placeholderColor="silver" textChange="{{textChangeArea}}" color="black" width="80%" borderColor="silver" borderWidth="1" height="200" borderRadius="4" fontSize="14">
+      </TextView>
+
     </StackLayout>
   </ScrollView>
 </Page>

packages/core/ui/index.ts

@@ -75,7 +75,7 @@ export { TextBase, getTransformedText, letterSpacingProperty, textAlignmentPrope
 export { FormattedString } from './text-base/formatted-string';
 export { Span } from './text-base/span';
 export { TextField } from './text-field';
-export { TextView } from './text-view';
+export { TextView, WritingToolsAllowedInput, WritingToolsBehavior } from './text-view';
 export { TimePicker } from './time-picker';
 export { Transition } from './transition';
 export { ModalTransition } from './transition/modal-transition';

packages/core/ui/text-view/index.android.ts

@@ -1,6 +1,6 @@
 import { TextViewBase as TextViewBaseCommon } from './text-view-common';
 import { CSSType } from '../core/view';
-
+export { WritingToolsAllowedInput, WritingToolsBehavior } from './text-view-common';
 export * from '../text-base';
 
 @CSSType('TextView')

packages/core/ui/text-view/index.d.ts

@@ -1,5 +1,6 @@
 import { EditableTextBase } from '../editable-text-base';
 import { Property } from '../core/properties';
+export { WritingToolsAllowedInput, WritingToolsBehavior } from './text-view-common';
 
 /**
  * Represents an editable multiline text view.
@@ -30,6 +31,16 @@ export class TextView extends EditableTextBase {
 	 * @nsProperty
 	 */
 	maxLines: number;
+
+	/**
+	 * (iOS Only) Are Apple Intelligence writing tools active
+	 */
+	isWritingToolsActive: boolean;
+
+	/**
+	 * (iOS Only) Allow Apple Intelligence writing tools to emit text changes on each alteration instead of after the final change (default).
+	 */
+	enableWritingToolsEvents: boolean;
 }
 
 export const maxLinesProperty: Property<EditableTextBase, number>;

packages/core/ui/text-view/index.ios.ts

@@ -1,16 +1,16 @@
 import { ScrollEventData } from '../scroll-view';
 import { textProperty } from '../text-base';
-import { TextViewBase as TextViewBaseCommon } from './text-view-common';
+import { iosWritingToolsAllowedInputProperty, iosWritingToolsBehaviorProperty, TextViewBase as TextViewBaseCommon, WritingToolsAllowedInput, WritingToolsBehavior } from './text-view-common';
 import { editableProperty, hintProperty, placeholderColorProperty, _updateCharactersInRangeReplacementString } from '../editable-text-base';
 import { CoreTypes } from '../../core-types';
 import { CSSType } from '../core/view';
 import { Color } from '../../color';
 import { colorProperty, borderTopWidthProperty, borderRightWidthProperty, borderBottomWidthProperty, borderLeftWidthProperty, paddingTopProperty, paddingRightProperty, paddingBottomProperty, paddingLeftProperty, Length } from '../styling/style-properties';
-import { iOSNativeHelper, layout } from '../../utils';
+import { layout, isRealDevice } from '../../utils';
+import { SDK_VERSION } from '../../utils/constants';
 
 import { profile } from '../../profiling';
-
-const majorVersion = iOSNativeHelper.MajorVersion;
+export { WritingToolsAllowedInput, WritingToolsBehavior } from './text-view-common';
 
 @NativeClass
 class UITextViewDelegateImpl extends NSObject implements UITextViewDelegate {
@@ -70,6 +70,21 @@ class UITextViewDelegateImpl extends NSObject implements UITextViewDelegate {
 			return owner.scrollViewDidScroll(sv);
 		}
 	}
+
+	public textViewWritingToolsWillBegin(textView: UITextView): void {
+		const owner = this._owner?.deref();
+		if (owner) {
+			owner.isWritingToolsActive = true;
+		}
+	}
+
+	public textViewWritingToolsDidEnd(textView: UITextView): void {
+		const owner = this._owner?.deref();
+		if (owner) {
+			owner.isWritingToolsActive = false;
+			owner.textViewDidChange(textView);
+		}
+	}
 }
 
 @NativeClass
@@ -92,8 +107,8 @@ export class TextView extends TextViewBaseCommon {
 
 	public _isEditing: boolean;
 
-	private _hintColor = majorVersion <= 12 || !UIColor.placeholderTextColor ? UIColor.blackColor.colorWithAlphaComponent(0.22) : UIColor.placeholderTextColor;
-	private _textColor = majorVersion <= 12 || !UIColor.labelColor ? null : UIColor.labelColor;
+	private _hintColor = SDK_VERSION <= 12 || !UIColor.placeholderTextColor ? UIColor.blackColor.colorWithAlphaComponent(0.22) : UIColor.placeholderTextColor;
+	private _textColor = SDK_VERSION <= 12 || !UIColor.labelColor ? null : UIColor.labelColor;
 
 	createNativeView() {
 		const textView = NoScrollAnimationUITextView.new();
@@ -144,10 +159,12 @@ export class TextView extends TextViewBaseCommon {
 	}
 
 	public textViewDidChange(textView: UITextView): void {
-		if (this.updateTextTrigger === 'textChanged') {
-			textProperty.nativeValueChange(this, textView.text);
+		if (!this.isWritingToolsActive || this.enableWritingToolsEvents) {
+			if (this.updateTextTrigger === 'textChanged') {
+				textProperty.nativeValueChange(this, textView.text);
+			}
+			this.requestLayout();
 		}
-		this.requestLayout();
 	}
 
 	public textViewShouldChangeTextInRangeReplacementText(textView: UITextView, range: NSRange, replacementString: string): boolean {
@@ -399,6 +416,52 @@ export class TextView extends TextViewBaseCommon {
 			right: inset.right,
 		};
 	}
+
+	[iosWritingToolsBehaviorProperty.setNative](value: WritingToolsBehavior) {
+		if (SDK_VERSION >= 18 && isRealDevice()) {
+			this.nativeTextViewProtected.writingToolsBehavior = this._writingToolsBehaviorType(value);
+		}
+	}
+
+	[iosWritingToolsAllowedInputProperty.setNative](value: Array<WritingToolsAllowedInput>) {
+		if (SDK_VERSION >= 18 && isRealDevice()) {
+			let writingToolsInput = null;
+			for (const inputType of value) {
+				writingToolsInput = (writingToolsInput != null ? writingToolsInput : 0) + this._writingToolsAllowedType(inputType);
+			}
+			if (writingToolsInput === null) {
+				writingToolsInput = UIWritingToolsResultOptions.Default;
+			}
+			this.nativeTextViewProtected.allowsEditingTextAttributes = true;
+			this.nativeTextViewProtected.allowedWritingToolsResultOptions = writingToolsInput;
+		}
+	}
+
+	private _writingToolsBehaviorType(value: WritingToolsBehavior) {
+		switch (value) {
+			case WritingToolsBehavior.Complete:
+				return UIWritingToolsBehavior.Complete;
+			case WritingToolsBehavior.Default:
+				return UIWritingToolsBehavior.Default;
+			case WritingToolsBehavior.Limited:
+				return UIWritingToolsBehavior.Limited;
+			case WritingToolsBehavior.None:
+				return UIWritingToolsBehavior.None;
+		}
+	}
+
+	private _writingToolsAllowedType(value: WritingToolsAllowedInput) {
+		switch (value) {
+			case WritingToolsAllowedInput.Default:
+				return UIWritingToolsResultOptions.Default;
+			case WritingToolsAllowedInput.List:
+				return UIWritingToolsResultOptions.List;
+			case WritingToolsAllowedInput.PlainText:
+				return UIWritingToolsResultOptions.PlainText;
+			case WritingToolsAllowedInput.RichText:
+				return UIWritingToolsResultOptions.RichText;
+		}
+	}
 }
 
 TextView.prototype.recycleNativeView = 'auto';

packages/core/ui/text-view/text-view-common.ts

@@ -1,8 +1,45 @@
+import { Property } from '../core/properties';
+import { booleanConverter } from '../core/view-base';
 import { TextView as TextViewDefinition } from '.';
 import { EditableTextBase } from '../editable-text-base';
 
 export class TextViewBase extends EditableTextBase implements TextViewDefinition {
 	public static returnPressEvent = 'returnPress';
 
 	public maxLines: number;
+	public isWritingToolsActive: boolean;
+	public enableWritingToolsEvents: boolean;
 }
+
+/**
+ * (iOS Only) Behavior for Apple Intelligence Writing Tools
+ * @since 8.9
+ */
+export enum WritingToolsBehavior {
+	Complete,
+	Default,
+	Limited,
+	None,
+}
+export const iosWritingToolsBehaviorProperty = new Property<TextViewBase, WritingToolsBehavior>({
+	name: 'iosWritingToolsBehavior',
+	defaultValue: WritingToolsBehavior.Default,
+});
+iosWritingToolsBehaviorProperty.register(TextViewBase);
+
+/**
+ * (iOS Only) Allowed input for Apple Intelligence Writing Tools
+ * @since 8.9
+ */
+export enum WritingToolsAllowedInput {
+	Default,
+	List,
+	PlainText,
+	RichText,
+	Table,
+}
+export const iosWritingToolsAllowedInputProperty = new Property<TextViewBase, Array<WritingToolsAllowedInput>>({
+	name: 'iosWritingToolsAllowedInput',
+	defaultValue: [WritingToolsAllowedInput.Default],
+});
+iosWritingToolsAllowedInputProperty.register(TextViewBase);

packages/core/utils/ios/index.ts

@@ -192,11 +192,10 @@ export function createUIDocumentInteractionControllerDelegate(): NSObject {
 
 export function isRealDevice() {
 	try {
-		// https://stackoverflow.com/a/5093092/4936697
-		const sourceType = UIImagePickerControllerSourceType.UIImagePickerControllerSourceTypeCamera;
-		const mediaTypes = UIImagePickerController.availableMediaTypesForSourceType(sourceType);
-
-		return !!mediaTypes;
+		if (NSProcessInfo.processInfo.environment.valueForKey('SIMULATOR_DEVICE_NAME')) {
+			return false;
+		}
+		return true;
 	} catch (e) {
 		return true;
 	}

packages/types-ios/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nativescript/types-ios",
-	"version": "8.8.0",
+	"version": "8.9.0-alpha.0",
 	"description": "NativeScript Types for iOS.",
 	"homepage": "https://nativescript.org",
 	"repository": {