Skip to content

Commit

Permalink
docs: mark as optional property "animated" of AnimationOption
Browse files Browse the repository at this point in the history
Property "animated" is not required by View's "hide" and "show" methods.
Also it will cause errors in TypeScript declaration file (if you'll try
to build one from docs) for methods "hide" and "show" of
"Titanium.UI.iPad.Popover" class.

```typescript

declare interface AnimationOption {
    animated?: boolean;  // "animated: boolean;" will cause "Error TS2416"
}

declare interface PopoverParams {
    animated?: boolean;
    rect?: Dimension;
    view: Titanium.UI.View;
}

class View extends Titanium.Proxy {
    hide(options?: AnimationOption): void;
    show(options?: AnimationOption): void;
}

class Popover extends Titanium.UI.View {
    hide(options: PopoverParams): void;
    show(params: PopoverParams): void;
}
```
  • Loading branch information
drauggres authored and sgtcoolguy committed Nov 21, 2019
1 parent 163065a commit aee1bdd
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions apidoc/Titanium/UI/View.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2017,6 +2017,7 @@ properties:
summary: Determines whether to enable a circular reveal animation.
type: Boolean
default: false
optional: true
osver: {android: {min: 5.0}}

---
Expand Down

0 comments on commit aee1bdd

Please sign in to comment.