From 8ebbeb0d8edbdaccee08ce729b17d5821cdc859e Mon Sep 17 00:00:00 2001 From: "Stefano J. Attardi" Date: Wed, 7 Oct 2020 23:43:29 -0700 Subject: [PATCH 1/2] Full ART types extracted from the React Native types --- index.d.ts | 277 ++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 233 insertions(+), 44 deletions(-) diff --git a/index.d.ts b/index.d.ts index 98ed7e0..94c2dd1 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,70 +1,259 @@ declare module '@react-native-community/art' { - import {ViewStyle, StyleProp} from 'react-native'; - import React from 'react'; + type FlexAlignType = 'flex-start' | 'flex-end' | 'center' | 'stretch' | 'baseline'; - export interface ARTNodeMixin { - opacity?: number; - originX?: number; - originY?: number; + /** + * Flex Prop Types + * @see https://facebook.github.io/react-native/docs/flexbox.html#proptypes + * @see LayoutPropTypes.js + */ + interface FlexStyle { + alignContent?: + | 'flex-start' + | 'flex-end' + | 'center' + | 'stretch' + | 'space-between' + | 'space-around'; + alignItems?: FlexAlignType; + alignSelf?: 'auto' | FlexAlignType; + aspectRatio?: number; + borderBottomWidth?: number; + borderLeftWidth?: number; + borderRightWidth?: number; + borderTopWidth?: number; + borderWidth?: number; + bottom?: number | string; + flex?: number; + flexBasis?: number | string; + flexDirection?: 'row' | 'column' | 'row-reverse' | 'column-reverse'; + flexGrow?: number; + flexShrink?: number; + flexWrap?: 'wrap' | 'nowrap'; + height?: number | string; + justifyContent?: 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around'; + left?: number | string; + margin?: number | string; + marginBottom?: number | string; + marginHorizontal?: number | string; + marginLeft?: number | string; + marginRight?: number | string; + marginTop?: number | string; + marginVertical?: number | string; + maxHeight?: number | string; + maxWidth?: number | string; + minHeight?: number | string; + minWidth?: number | string; + overflow?: 'visible' | 'hidden' | 'scroll'; + padding?: number | string; + paddingBottom?: number | string; + paddingHorizontal?: number | string; + paddingLeft?: number | string; + paddingRight?: number | string; + paddingTop?: number | string; + paddingVertical?: number | string; + position?: 'absolute' | 'relative'; + right?: number | string; + top?: number | string; + width?: number | string; + zIndex?: number; + + /** + * @platform ios + */ + direction?: 'inherit' | 'ltr' | 'rtl'; + } + + interface PerpectiveTransform { + perspective: number; + } + + interface RotateTransform { + rotate: string; + } + + interface RotateXTransform { + rotateX: string; + } + + interface RotateYTransform { + rotateY: string; + } + + interface RotateZTransform { + rotateZ: string; + } + + interface ScaleTransform { + scale: number; + } + + interface ScaleXTransform { + scaleX: number; + } + + interface ScaleYTransform { + scaleY: number; + } + + interface TranslateXTransform { + translateX: number; + } + + interface TranslateYTransform { + translateY: number; + } + + interface SkewXTransform { + skewX: string; + } + + interface SkewYTransform { + skewY: string; + } + + interface TransformsStyle { + transform?: ( + | PerpectiveTransform + | RotateTransform + | RotateXTransform + | RotateYTransform + | RotateZTransform + | ScaleTransform + | ScaleXTransform + | ScaleYTransform + | TranslateXTransform + | TranslateYTransform + | SkewXTransform + | SkewYTransform + )[]; + transformMatrix?: Array; + rotation?: number; scaleX?: number; scaleY?: number; - scale?: number; - title?: string; - x?: number; - y?: number; - visible?: boolean; + translateX?: number; + translateY?: number; + } + + // @see https://facebook.github.io/react-native/docs/view.html#style + interface ViewStyle extends FlexStyle, TransformsStyle { + backfaceVisibility?: 'visible' | 'hidden'; + backgroundColor?: string; + borderBottomColor?: string; + borderBottomLeftRadius?: number; + borderBottomRightRadius?: number; + borderBottomWidth?: number; + borderColor?: string; + borderLeftColor?: string; + borderRadius?: number; + borderRightColor?: string; + borderRightWidth?: number; + borderStyle?: 'solid' | 'dotted' | 'dashed'; + borderTopColor?: string; + borderTopLeftRadius?: number; + borderTopRightRadius?: number; + borderTopWidth?: number; + display?: 'none' | 'flex'; + opacity?: number; + overflow?: 'visible' | 'hidden'; + shadowColor?: string; + shadowOffset?: {width: number; height: number}; shadowOpacity?: number; - shadowColor?: string | number; shadowRadius?: number; - shadowOffset?: { - x: number, - y: number, - } + elevation?: number; + testID?: string; } - export interface ARTGroupProps extends ARTNodeMixin { - width?: number; - height?: number; + type Falsy = undefined | null | false; + interface RecursiveArray extends Array> {} + /** Keep a brand of 'T' so that calls to `StyleSheet.flatten` can take `RegisteredStyle` and return `T`. */ + type RegisteredStyle = number & {__registeredStyleBrand: T}; + type StyleProp = + | T + | RegisteredStyle + | RecursiveArray | Falsy> + | Falsy; + + export interface ARTShapeProps { + d: string | PathStatic; + strokeWidth?: number; + strokeDash?: number[]; + stroke?: string; + fill?: string | LinearGradientStatic; + strokeCap?: 'square' | 'butt' | 'round'; + transform?: string | TransformStatic; } - export interface ARTClippingRectangleProps extends ARTNodeMixin { - width?: number; - height?: number; + export interface ARTSurfaceProps { + style?: StyleProp; + width: number; + height: number; } - export interface ARTRenderableMixin extends ARTNodeMixin { + export interface ARTTextProps { + font: string; fill?: string; - stroke?: string; - strokeCap?: 'butt' | 'square' | 'round'; - strokeDash?: number[]; - strokeJoin?: 'bevel' | 'miter' | 'round'; - strokeWidth?: number; + x: number; + y: number; + alignment?: 'left' | 'center' | 'right'; } - export interface ARTShapeProps extends ARTRenderableMixin { - d: string; - width?: number; - height?: number; + export interface ARTGroupProps { + transform?: string | TransformStatic; } - export interface ARTTextProps extends ARTRenderableMixin { - font?: string; - alignment?: string; + interface ShapeStatic extends React.ComponentClass {} + + interface SurfaceStatic extends React.ComponentClass {} + + interface PathStatic { + new (): PathStatic; + move(dx: number, dy: number): PathStatic; + moveTo(x: number, y: number): PathStatic; + line(dx: number, dy: number): PathStatic; + lineTo(x: number, y: number): PathStatic; + arc(dx: number, dy: number, radius: number): PathStatic; + arcTo(x: number, y: number, radius: number): PathStatic; + close(): PathStatic; } - export interface ARTSurfaceProps { - style?: StyleProp; - width: number; - height: number; + interface TransformStatic { + new (): TransformStatic; + move(dx: number, dy: number): TransformStatic; + rotate(angle: number, cx?: number, cy?: number): TransformStatic; } - export class ClippingRectangle extends React.Component {} + export interface ARTTextStatic extends React.ComponentClass {} - export class Group extends React.Component {} + interface GroupStatic extends React.ComponentClass {} - export class Shape extends React.Component {} + interface LinearGradientStatic extends React.ComponentClass { + new ( + stops: {[stop: string]: string}, + x0: number, + y0: number, + x1: number, + y1: number, + ): LinearGradientStatic; + } - export class Surface extends React.Component {} + ////////////////////////////////////////////////////////////////////////// + // + // R E - E X P O R T S + // + ////////////////////////////////////////////////////////////////////////// - export class Text extends React.Component {} + export var Shape: ShapeStatic; + export type Shape = ShapeStatic; + export var Surface: SurfaceStatic; + export type Surface = SurfaceStatic; + export var Text: ARTTextStatic; + export type Text = ARTTextStatic; + export var Path: PathStatic; + export type Path = PathStatic; + export var Group: GroupStatic; + export type Group = GroupStatic; + export var LinearGradient: LinearGradientStatic; + export type LinearGradient = LinearGradientStatic; + export var Transform: TransformStatic; + export type Transform = TransformStatic; } From 59d29ab4a62d06326e1d0b00e07386acac2c5836 Mon Sep 17 00:00:00 2001 From: Tom Xu Date: Tue, 22 Jun 2021 15:44:07 +0800 Subject: [PATCH 2/2] remove comments --- index.d.ts | 6 ------ 1 file changed, 6 deletions(-) diff --git a/index.d.ts b/index.d.ts index 94c2dd1..81c748c 100644 --- a/index.d.ts +++ b/index.d.ts @@ -236,12 +236,6 @@ declare module '@react-native-community/art' { ): LinearGradientStatic; } - ////////////////////////////////////////////////////////////////////////// - // - // R E - E X P O R T S - // - ////////////////////////////////////////////////////////////////////////// - export var Shape: ShapeStatic; export type Shape = ShapeStatic; export var Surface: SurfaceStatic;