Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add type #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,10 @@ You can use `ref` property to access the widget instance and call control functi
- `instance()`

```js
import AnnounceKit, {Handler} from "announcekit-react";

function App() {
const ref = React.createRef<AnnounceKit>();
const ref = React.createRef<Handler>();

React.useEffect(() => {
ref.current.unread().then(an => console.log("unread", an));
Expand Down
22 changes: 15 additions & 7 deletions src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ export type AnnounceKitProps = {
customConfig?: any;
};

export type Handler = {
withWidget: (fn: Function) => Promise<any>;
open: () => void;
close: () => void;
instance: () => any;
unread: () => Promise<number>;
};

function globalAnnouncekit() {
const win = window as any;

Expand Down Expand Up @@ -68,7 +76,7 @@ function AnnounceKit(props: AnnounceKitProps, ref: any) {
const widgetRef = useRef<any>(null);
const widgetHandlers = useRef<any>([]);

useImperativeHandle(ref, () => ({
useImperativeHandle<any, Handler>(ref, () => ({
withWidget(fn: Function): any {
return new Promise((res) => {
if (widgetRef.current) {
Expand All @@ -89,11 +97,11 @@ function AnnounceKit(props: AnnounceKitProps, ref: any) {
this.withWidget((widget: any) => widget.close());
},

instance(): any {
instance(): Promise<any> {
return this.withWidget((widget: any) => widget);
},

unread(): number {
unread(): Promise<number> {
return this.withWidget((widget: any) => widget.state.ui.unreadCount);
}
}));
Expand Down Expand Up @@ -174,18 +182,18 @@ function AnnounceKit(props: AnnounceKitProps, ref: any) {
framework_version: "2.0.0",

react_symbol: widgetSymbol,

line: {
style: floatWidget ? {} : { ...widgetStyle }
},

badge: {
style: floatWidget ? {} : { ...widgetStyle }
},

float: {
style: { ...widgetStyle }
},
},

onInit: (w: any) => {
if (w.conf.react_symbol !== widgetSymbol) {
Expand Down