react(ts) 给第三方npm包react-page-layout书写声明文件

最近在写react/ts项目起手骨架,想省事一点,把之前的一个react项目起手骨架直接拿过来用。里面用到了一个公用布局第三方包react-page-layout,结果时间耽误好久在写这个包的d.ts声明文件,到最后还是被自己蠢哭了。写完之后,就记录一下。

首先install react-page-layout插件,安装完之后按照之前的布局代码将布局代码撸了一遍。(react-page-layout的具体使用方法请参考官方文档),撸好之后发现报错了。


按照提示 npm install @types/react-page-layout ,结果发现没有声明文件,估计插件作者已经忘了这插件了。理论上提pr是最好不过了。不过不是学习么,还是自己写下试试。

看了一遍ts声明文件的文档(https://www.tslang.cn/docs/handbook/declaration-files/introduction.html),还是先撸吧。

首先在src下面新建了@types目录,然后是react-page-layout目录,最后新建了index.d.ts文件,为什么这么建目录,为了看起来方便。比直接在根目录下建文件好看点。万一后面还有声明文件要写看起来也直观一点。(一般来说,ts 会解析项目中所有的 *.ts 文件。所以写好这个声明文件后,其他所有 *.ts 文件就都可以获得 react-page-layout的类型定义了。)


既然是第三方的包,引入的时候使用import{...} from 'react-page-layout'的方式,那第一行就写 declare module 'react-page-layout' {} 这个了


报错变了。好像有点效果啊,看看报错Module '"react-page-layout"' has no exported member 'Slot'. TS2305继续往下写吧。


报错又变了。继续往下撸吧。


神奇的报错。需要去看下插件里面关于Slot这个组件的代码了。


既然这样,先这么写吧。


好像有点作用啊,因为报错又变了。


刚刚的好像解决了。因为报错又变了。


Slot部分的好像解决了


查看下插件关于LayoutProvider这部分代码


于是继续按照上面的套路一直这么写下去。全部写完之后就是这样了


按照报错提示都撸完以后。。。怎么还报错。。。



在插件的build/page.js里面console了一下this.context,context下的getLayout方法是undefined,一时百思不得其解,困扰了好久。难道是声明文件写的不对造成context没传过来?中间把声明文件折腾出很多个版本,各种思路都有过(包括把的LayoutProvider里childContextTypes声明出来之类的),直到我感觉我要给作者提pr的时候,我看到了我的路由守卫文件。。。


我把LayoutProvider包在了Redirect外面。。。改成包裹在Route外面就好了。


终于报错解决了,页面正常了。这个插件可以正常用了。


又看到之前的注释里有写组件可能会添加自定义属性了,这个时候TS验证可能会报错,就又需要改声明文件了。


干脆把声明文件改了。any大法真好



写这篇文章的时候,把之前的报错解决过程又重复了一遍。突然发现,原来只要export出来就直接可以用了,突然感觉自己是个十足的蠢货。。。



但是原因还是要分析的,个人感觉因为这是个react组件式的插件,依赖的react.d.ts,proptypes.d.ts都有声明,其实只要声明本身有这个定义就可以了。希望有大神帮忙解答下。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345