Skip to content

Commit a42abd0

Browse files
tmorehousejacobmllr95
authored andcommitted
feat(types): better type declarations (closes #1976) (#3283)
* chore(types): declare `/es` modules * Update index.d.ts * Update es.d.ts * Update es.d.ts * Update es.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update es.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Create src.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update bv-config.d.ts * Update es.d.ts * Update src.d.ts * Update es.d.ts * Update package.json * Update build.sh * Delete es.d.ts * Delete bv-event.d.ts * Update index.d.ts * Delete bv-plugin.d.ts * Delete src.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update index.d.ts * Update bv-config.d.ts * Rename types/vue-injections.d.ts to src/vue-injections.d.ts * Rename types/bv-config.d.ts to src/bv-config.d.ts * Rename types/directives/index.d.ts to types/src/directives/index.d.ts * Rename types/src/directives/index.d.ts to src/directives/index.d.ts * Rename types/directives/modal/index.d.ts to src/directives/modal/index.d.ts * Rename types/directives/popover/index.d.ts to src/directives/popover/index.d.ts * Rename types/directives/scrollspy/index.d.ts to src/directives/scrollspy/index.d.ts * Rename types/directives/toggle/index.d.ts to src/directives/toggle/index.d.ts * Rename types/directives/tooltip/index.d.ts to src/directives/tooltip/index.d.ts * Rename types/index.d.ts to src/index.d.ts * Rename types/components/alert/index.d.ts to src/components/alert/index.d.ts * Rename types/components/badge/index.d.ts to src/components/badge/index.d.ts * Rename types/components/breadcrumb/index.d.ts to src/components/breadcrumb/index.d.ts * Rename types/components/button-group/index.d.ts to src/components/button-group/index.d.ts * Rename types/components/button-toolbar/index.d.ts to src/components/button-toolbar/index.d.ts * Rename types/components/button/index.d.ts to src/components/button/index.d.ts * Rename types/components/card/index.d.ts to src/components/card/index.d.ts * Rename types/components/carousel/index.d.ts to src/components/carousel/index.d.ts * Rename types/components/collapse/index.d.ts to src/components/collapse/index.d.ts * Rename types/components/dropdown/index.d.ts to src/components/dropdown/index.d.ts * Rename types/components/embed/index.d.ts to src/components/embed/index.d.ts * Rename types/components/form-checkbox/index.d.ts to src/components/form-checkbox/index.d.ts * Rename types/components/form-file/index.d.ts to src/components/form-file/index.d.ts * Rename types/components/form-group/index.d.ts to src/components/form-group/index.d.ts * Rename types/components/form-input/index.d.ts to src/components/form-input/index.d.ts * Rename types/components/form-radio/index.d.ts to src/components/form-radio/index.d.ts * Rename types/components/form-select/index.d.ts to src/components/form-select/index.d.ts * Rename types/components/form-textarea/index.d.ts to src/components/form-textarea/index.d.ts * Rename types/components/form/index.d.ts to src/components/form/index.d.ts * Rename types/components/image/index.d.ts to src/components/image/index.d.ts * Rename types/components/input-group/index.d.ts to src/components/input-group/index.d.ts * Rename types/components/jumbotron/index.d.ts to src/components/jumbotron/index.d.ts * Rename types/components/layout/index.d.ts to src/components/layout/index.d.ts * Rename types/components/link/index.d.ts to src/components/link/index.d.ts * Rename types/components/list-group/index.d.ts to src/components/list-group/index.d.ts * Rename types/components/media/index.d.ts to src/components/media/index.d.ts * Rename types/components/modal/index.d.ts to src/components/modal/index.d.ts * Rename types/components/nav/index.d.ts to src/components/nav/index.d.ts * Rename types/components/navbar/index.d.ts to src/components/navbar/index.d.ts * Rename types/components/pagination-nav/index.d.ts to src/components/pagination-nav/index.d.ts * Rename types/components/pagination/index.d.ts to src/components/pagination/index.d.ts * Rename types/components/popover/index.d.ts to src/components/popover/index.d.ts * Rename types/components/progress/index.d.ts to src/components/progress/index.d.ts * Rename types/components/spinner/index.d.ts to src/components/spinner/index.d.ts * Rename types/components/table/index.d.ts to src/components/table/index.d.ts * Rename types/components/tabs/index.d.ts to src/components/tabs/index.d.ts * Rename types/components/toast/index.d.ts to src/components/toast/index.d.ts * Rename types/components/tooltip/index.d.ts to src/components/tooltip/index.d.ts * Rename types/components/index.d.ts to src/components/index.d.ts * Delete README.md * Update package.json * Update build.sh * Update build.sh * Update build.sh * Update build.sh * Update index.d.ts * Update build.sh
1 parent 5c14f12 commit a42abd0

File tree

96 files changed

+794
-834
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+794
-834
lines changed

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
"jsnext:main": "es/index.js",
99
"style": "dist/bootstrap-vue.css",
1010
"license": "MIT",
11-
"types": "types/index.d.ts",
12-
"typings": "types/index.d.ts",
11+
"types": "src/index.d.ts",
1312
"repository": "bootstrap-vue/bootstrap-vue",
1413
"homepage": "https://bootstrap-vue.js.org",
1514
"contributors": [

scripts/build.sh

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,18 @@ cleancss --level 1 \
6868
echo 'Done.'
6969
echo ''
7070

71+
echo 'Copying types from src/ to es/ ...'
72+
# There must be a better way to do this
73+
#
74+
# The following does not preserve the paths
75+
# shopt -s globstar
76+
# cp src/**/*.d.ts es
77+
#
78+
# So we resort to a find with exec
79+
cd src
80+
find . -type f -name '*.d.ts' -exec cp {} ../es/{} ';'
81+
cd ..
82+
echo 'Done.'
83+
echo ''
84+
7185
echo 'Done building assets.'

src/bv-config.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import Vue, { PluginFunction, PluginObject } from 'vue'
2+
import { BvPlugin } from './'
3+
4+
export declare const BVConfigPlugin: BvPlugin
5+
export default BVConfigPlugin

src/components/alert/index.d.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
//
2+
// Alert
3+
//
4+
import Vue from 'vue'
5+
import { BvPlugin, BvComponent } from '../../'
6+
7+
// Plugin
8+
export declare const AlertPlugin: BvPlugin
9+
export default AlertPlugin
10+
11+
// Component: b-alert
12+
export declare class BAlert extends BvComponent {}

src/components/badge/index.d.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
//
2+
// Badge
3+
//
4+
import Vue from 'vue'
5+
import { BvPlugin, BvComponent } from '../../'
6+
7+
// Plugin
8+
export declare const BadgePlugin: BvPlugin
9+
export default BadgePlugin
10+
11+
// Component: b-badge
12+
export declare class BBadge extends BvComponent {}

src/components/breadcrumb/index.d.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
//
2+
// Breadcrumb
3+
//
4+
import Vue from 'vue'
5+
import { BvPlugin, BvComponent } from '../../'
6+
7+
// Plugin
8+
export declare const BreadcrumbPlugin: BvPlugin
9+
export default BreadcrumbPlugin
10+
11+
// Component: b-breadcrumb
12+
export declare class BBreadcrumb extends BvComponent {}
13+
14+
// Component: b-breadcrumb-item
15+
export declare class BBreadcrumbItem extends BvComponent {}
16+
17+
// Component: b-breadcrumb-link
18+
export declare class BBreadcrumbLink extends BvComponent {}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
//
2+
// Button Group
3+
//
4+
import Vue from 'vue'
5+
import { BvPlugin, BvComponent } from '../../'
6+
7+
// Plugin
8+
export declare const ButtonGroupPlugin: BvPlugin
9+
export default ButtonGroupPlugin
10+
11+
// Component: b-button-group
12+
export declare class BButtonGroup extends BvComponent {}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
//
2+
// Button Toolbar
3+
//
4+
import Vue from 'vue'
5+
import { BvPlugin, BvComponent } from '../../'
6+
7+
// Plugin
8+
export declare const ButtonToolbarPlugin: BvPlugin
9+
export default ButtonToolbarPlugin
10+
11+
// Component: b-button-toolbar
12+
export declare class BButtonToolbar extends BvComponent {}

src/components/button/index.d.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
//
2+
// Buttons
3+
//
4+
import Vue from 'vue'
5+
import { BvPlugin, BvComponent } from '../../'
6+
7+
// Plugin
8+
export declare const ButtonPlugin: BvPlugin
9+
export default ButtonPlugin
10+
11+
// Component: b-button
12+
export declare class BButton extends BvComponent {}
13+
14+
// Component: b-button-close
15+
export declare class BButtonClose extends BvComponent {}

src/components/card/index.d.ts

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
//
2+
// Card
3+
//
4+
import Vue from 'vue'
5+
import { BvPlugin, BvComponent } from '../../'
6+
7+
// Plugin
8+
export declare const CardPlugin: BvPlugin
9+
export default CardPlugin
10+
11+
// Component: b-card
12+
export declare class BCard extends BvComponent {}
13+
14+
// Component: b-card-header
15+
export declare class BCardHeader extends BvComponent {}
16+
17+
// Component: b-card-footer
18+
export declare class BCardFooter extends BvComponent {}
19+
20+
// Component: b-card-body
21+
export declare class BCardBody extends BvComponent {}
22+
23+
// Component: b-card-title
24+
export declare class BCardTitle extends BvComponent {}
25+
26+
// Component: b-card-subtitle
27+
export declare class BCardSubtitle extends BvComponent {}
28+
29+
// Component: b-card-img
30+
export declare class BCardImg extends BvComponent {}
31+
32+
// Component: b-card-img-lazy
33+
export declare class BCardImgLazy extends BvComponent {}
34+
35+
// Component: b-card-text
36+
export declare class BCardText extends BvComponent {}
37+
38+
// Component: b-card-group
39+
export declare class BCardGroup extends BvComponent {}

0 commit comments

Comments
 (0)