Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(docs): remove new/enhances/changed badges #3870

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

Merged
merged 5 commits into from
Aug 14, 2019
Merged
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
25 changes: 4 additions & 21 deletions docs/components/importdoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
</anchored-heading>

<p>
<b-badge variant="info" class="small">CHANGED in 2.0.0-rc.22</b-badge> You can
import individual components into your project via the following named exports:
You can import individual components into your project via the following named
exports:
</p>

<b-table
Expand Down Expand Up @@ -45,8 +45,8 @@
</anchored-heading>

<p>
<b-badge variant="info" class="small">CHANGED in 2.0.0-rc.22 </b-badge> You can
import individual directives into your project via the following named exports:
You can import individual directives into your project via the following named
exports:
</p>

<b-table
Expand Down Expand Up @@ -78,11 +78,6 @@
Importing as a Vue.js plugin
</anchored-heading>

<p>
<b-badge variant="info" class="small">CHANGED in 2.0.0-rc.22</b-badge> Importing plugins
has been simplified.
</p>

<p v-if="isComponentRoute">
This plugin includes all of the above listed individual
components<span v-if="directives.length"> and directives</span>.
Expand Down Expand Up @@ -122,18 +117,6 @@
<p><strong>Example:</strong></p>
<pre class="hljs language-js text-monospace p-2 notranslate" translate="no">{{ pluginImportCode }}</pre>
</article>

<aside class="alert alert-warning my-4">
<p class="mb-0">
<b-badge variant="warning" tag="strong">CHANGED as of v2.0.0:</b-badge>
Importing components, directives and plugins from
<code class="notranslate" translate="no">bootstrap-vue/es/*</code>
has been removed. All components, directives and plugins are now available as top-level named
exports in the <code class="notranslate" translate="no">ESM</code> and
<code class="notranslate" translate="no">CommonJS</code> builds. The
<code class="notranslate" translate="no">es/</code> directory build has been removed.
</p>
</aside>
</section>
</template>

Expand Down
57 changes: 7 additions & 50 deletions docs/markdown/intro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,6 @@ Guide for full details on setting up aliases for [webpack](https://webpack.js.or

## Tree shaking with module bundlers

<span class="badge badge-info small">SIMPLIFIED in 2.0.0-rc.20</span>

When using a module bundler you can optionally import only specific components groups (plugins),
components and/or directives.

Expand All @@ -208,8 +206,6 @@ components and/or directives.

### Component groups and directives as Vue plugins

<span class="badge badge-info small">CHANGED in 2.0.0-rc.22</span>

You can import component groups and directives as Vue plugins by importing from the `bootstrap-vue`:

<!-- eslint-disable import/first, import/no-duplicates -->
Expand Down Expand Up @@ -256,8 +252,6 @@ single `import` statement for optimal tree shaking.

### Individual components and directives

<span class="badge badge-info small">CHANGED in 2.0.0-rc.22</span>

If you would like to only pull in a specific component or set of components, you can do this by
directly importing those components.

Expand Down Expand Up @@ -304,8 +298,6 @@ object property shorthand (components only).

### Using BootstrapVue source code for smaller bundles

<span class="badge badge-info small">For advanced users</span>

When using module bundlers, they will usually default to using the `esm/` modular build, which has
been pre-transpiled by Babel for our
[supported browsers](https://github.com/bootstrap-vue/bootstrap-vue/blob/master/.browserslistrc).
Expand Down Expand Up @@ -439,14 +431,11 @@ import 'custom.scss'

### `transformAssetUrls` with Nuxt.js

<span class="badge badge-info small">NEW in v2.0.0-rc.22</span> The BootstrapVue Nuxt plugin module
will automatically add in the BootstrapVue specific [`transformAssetUrls`](/docs/reference/images)
image `src` prop configuration for you.
The BootstrapVue Nuxt plugin module will automatically add in the BootstrapVue specific
[`transformAssetUrls`](/docs/reference/images) image `src` prop configuration for you.

### Tree shaking with Nuxt.js

<span class="badge badge-info small">ENHANCED in 2.0.0-rc.20</span>

If you wish to reduce your production bundle size because you only use a subset of the available
BootstrapVue plugins, you can configure the list of BootstrapVue `componentPlugins` or
`directivePlugins` you want to globally install in your Nuxt.js project.
Expand All @@ -469,18 +458,17 @@ module.exports = {
}
```

<span class="badge badge-info small">NEW in 2.0.0-rc.20</span> There are two additional helper
plugins for providing the `$bvModal` and `$bvToast` injections (if you are not using the
`ModalPlugin` or `ToastPlugin` plugins) that are available in the `componentPlugins` option:
There are two additional helper plugins for providing the `$bvModal` and `$bvToast` injections (if
you are not using the `ModalPlugin` or `ToastPlugin` plugins) that are available in the
`componentPlugins` option:

- `BVModalPlugin` - provides the injection `$bvModal` for generating
[message boxes](/docs/components/modal#modal-message-boxes).
- `BVToastPlugin` - provides the injection `$bvToast` for generating
[on demand toasts](/docs/components/toast#toasts-on-demand).

<span class="badge badge-info small">NEW in 2.0.0-rc.20</span> You can also optionally import
individual components and/or directives, by configuring the list of BootstrapVue `components` or
`directives` you want to globally install in your Nuxt.js project.
You can also optionally import individual components and/or directives, by configuring the list of
BootstrapVue `components` or `directives` you want to globally install in your Nuxt.js project.

```js
module.exports = {
Expand Down Expand Up @@ -540,37 +528,6 @@ pre-transpiled versions, while setting it to `false` will always use `src/`. By
`usePretranspiled` is enabled in development mode only. You should not need to use this option as
the default is most optimal for performance.

## Vue CLI 2

<span class="badge badge-warning small">DEPRECATED</span> Use [Vue CLI 3](#vue-cli-3) instead.

BootstrapVue has two Vue CLI templates available:

- [webpack-simple](https://github.com/bootstrap-vue/webpack-simple): Quick scaffold for a proof of
concept or small app
- [webpack](https://github.com/bootstrap-vue/webpack): Larger, production ready template with more
options

```bash
# Ensure Vue CLI is installed and up to date
npm install -g vue-cli

# Initialize a BootstrapVue project in the directory 'my-project'
vue init bootstrap-vue/webpack-simple my-project

# Change into the directory
cd my-project

# Install dependencies
npm install

# Fire up the dev server with HMR
npm run dev
```

You can repeat the commands above replacing `bootstrap-vue/webpack-simple` with
`bootstrap-vue/webpack` for the webpack template.

## Vue CLI 3

Unlike V2, Vue CLI 3 doesn't use templates.
Expand Down
6 changes: 0 additions & 6 deletions docs/markdown/misc/settings/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Settings

<span class="badge badge-info small">NEW in 2.0.0-rc.16</span>

> BootstrapVue provides a few options for customizing component default values, and more.

## Configuring defaults
Expand All @@ -22,16 +20,12 @@ stored under the `formControls` property, while component specific defaults are
defined in the default configuration can be overridden. Attempting to set a config property that is
not defined in the default will generate a console warning.

The `formControls` entry was introduced in <span class="badge badge-info small">v2.0.0-rc.28</span>.

```json
{{ defaultConfig }}
```

### Setting new configuration values

<span class="badge badge-info small">ENHANCED in v2.0.0-rc.22</span>

When you `Vue.use(BootstrapVue)`, you can optionally pass a configuration object which specifies new
values to replace the default values. For example if you wish to define new breakpoint names (which
will generate appropriate properties on components such as `<b-col>` and `<b-form-group>`), so that
Expand Down
3 changes: 1 addition & 2 deletions docs/markdown/reference/accessibility/meta.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"title": "Accessibility",
"description": "A brief overview of BootstrapVue's features and limitations for the creation of accessible content.",
"new": true
"description": "A brief overview of BootstrapVue's features and limitations for the creation of accessible content."
}
5 changes: 2 additions & 3 deletions docs/markdown/reference/images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,8 @@ module.exports = {
}
```

<span class="badge badge-info small">NEW in v2.0.0-rc.22</span> If using the
[BootstrapVue Nuxt](/docs#nuxtjs-module) module with Nuxt.js, the plugin module will automatically
add in the BootstrapVue specific `transformAssetUrls` configuration for you.
If using the [BootstrapVue Nuxt](/docs#nuxtjs-module) module with Nuxt.js, the plugin module will
automatically add in the BootstrapVue specific `transformAssetUrls` configuration for you.

## Using `require` to resolve image paths

Expand Down
8 changes: 4 additions & 4 deletions docs/markdown/reference/size-props/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ values as you need to generate different utilities here.

```html
<div class="text-center">
<div class="w-25 p-3 mb-1 bg-secondary">Width 25%</div>
<div class="w-50 p-3 mb-1 bg-secondary">Width 50%</div>
<div class="w-75 p-3 mb-1 bg-secondary">Width 75%</div>
<div class="w-100 p-3 bg-secondary">Width 100%</div>
<div class="w-25 p-3 mb-1 bg-secondary text-light">Width 25%</div>
<div class="w-50 p-3 mb-1 bg-secondary text-light">Width 50%</div>
<div class="w-75 p-3 mb-1 bg-secondary text-light">Width 75%</div>
<div class="w-100 p-3 bg-secondary text-light">Width 100%</div>
</div>

<!-- widths.vue -->
Expand Down
20 changes: 0 additions & 20 deletions docs/markdown/reference/starter-templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,26 +81,6 @@ tags to load the required JavaScript and CSS in your page.
</html>
```

## Vue CLI 2

<span class="badge badge-warning small">DEPRECATED</span>

### `webpack-simple` example

Starter template: https://github.com/bootstrap-vue/webpack-simple

Note: you may need to adjust the template package.json file to use the latest BootstrapVue version

Coming soon!

### `webpack` example

Starter template: https://github.com/bootstrap-vue/webpack

Note: you may need to adjust the template package.json file to use the latest BootstrapVue version

Coming soon!

## Vue CLI 3

Vue CLI 3 is the newest way to create Vue apps.
Expand Down
4 changes: 0 additions & 4 deletions src/components/button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,6 @@ prop.

## Pill style

<span class="badge badge-info small">NEW in 2.0.0-rc.20</span>

Prefer buttons with a more rounded-pill style? Just set the prop `pill` to true.

```html
Expand All @@ -152,8 +150,6 @@ This prop adds the Bootstrap v4.3 utility class `.rounded-pill` on the rendered

## Squared style

<span class="badge badge-info small">NEW in 2.0.0-rc.22</span>

Prefer buttons with a more square corner style? Just set the prop `squared` to true.

```html
Expand Down
15 changes: 4 additions & 11 deletions src/components/dropdown/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,6 @@ router link `to` value via the `split-to` prop, while maintaining the look of a

### Split button type

<span class="badge badge-info small">NEW in 2.0.0-rc.27</span>

The split button defaults to a button `type` of `'button'`. You can specify an alternate type via
the `split-button-type` prop. Supported values are: `'button'`, `'submit'` and `'reset'`.

Expand Down Expand Up @@ -337,8 +335,6 @@ to `true`. This is useful when the dropdown is to be displayed as an icon.

## Lazy dropdown

<span class="badge badge-info small">NEW in 2.0.0-rc.26</span>

By default, `<b-dropdown>` renders the menu contents in the DOM even when the menu is not shown.
When there are a large number of dropdowns rendered on the same page, performance could be impacted
due to larger overall memory utilization. You can instruct `<b-dropdown>` to render the menu
Expand Down Expand Up @@ -592,8 +588,6 @@ the full list of events.

## Optionally scoped default slot

<span class="badge badge-info small">NEW in 2.0.0-rc.20</span>

The default slot is optionally scoped with the following scope available:

| Property or Method | Description |
Expand Down Expand Up @@ -656,11 +650,10 @@ form controls within the menu.

## Implementation notes

<span class="badge badge-info small">NEW in 2.0.0-rc.19</span> The dropdown menu is rendered with
semantic `<ul>` and `<li>` elements for accessibility reasons. The `.dropdown-menu` is the `<ul>`
element, while dropdown items (items, buttons, text, form, headers, and dividers) are wrapped in an
`<li>` element. If creating custom items to place inside the dropdown menu, ensure they are wrapped
with a plain `<li>`.
The dropdown menu is rendered with semantic `<ul>` and `<li>` elements for accessibility reasons.
The `.dropdown-menu` is the `<ul>` element, while dropdown items (items, buttons, text, form,
headers, and dividers) are wrapped in an `<li>` element. If creating custom items to place inside
the dropdown menu, ensure they are wrapped with a plain `<li>`.

On touch-enabled devices, opening a `<b-dropdown>` adds empty (noop) `mouseover` handlers to the
immediate children of the `<body>` element. This admittedly ugly hack is necessary to work around a
Expand Down
6 changes: 0 additions & 6 deletions src/components/form-checkbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,6 @@ or if using individual checkboxes not inside a `<b-form-checkbox-group>`, set th

## Control sizing

<span class="badge badge-info small">NEW in 2.0.0-rc.28</span>

Use the `size` prop to control the size of the checkbox. The default size is medium. Supported size
values are `sm` (small) and `lg` (large).

Expand Down Expand Up @@ -406,8 +404,6 @@ Render groups of checkboxes with the look of a switches by setting the prop `swi

### Switch sizing

<span class="badge badge-info small">NEW in 2.0.0-rc.28</span>

Use the `size` prop to control the size of the switch. The default size is medium. Supported size
values are `sm` (small) and `lg` (large).

Expand Down Expand Up @@ -547,8 +543,6 @@ the group.

## Autofocus

<span class="badge badge-info small">NEW in 2.0.0-rc.21</span>

When the `autofocus` prop is set on `<b-form-checkbox>`, the input will be auto-focused when it is
inserted into the document, or re-activated when inside a Vue `<keep-alive>` component. Note that
this prop **does not** set the `autofocus` attribute on the input.
Expand Down
1 change: 0 additions & 1 deletion src/components/form-checkbox/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"version": "1.0.0",
"meta": {
"title": "Form Checkbox",
"enhanced": true,
"description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.",
"components": [
{
Expand Down
4 changes: 0 additions & 4 deletions src/components/form-file/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,6 @@ customizing its appearance.

### Control sizing

<span class="badge badge-info small">NEW in 2.0.0-rc.28</span>

Use the `size` prop to control the visual size of the input. The default size is considered `md`
(medium). Optional sizes are `lg` (large) and `sm` (small). These sizes line up with the sizes
available on other form controls.
Expand Down Expand Up @@ -237,8 +235,6 @@ To apply one of the contextual state icons on `<b-form-file`, set the `state` pr

## Autofocus

<span class="badge badge-info small">NEW in 2.0.0-rc.21</span>

When the `autofocus` prop is set on `<b-form-file>`, the input will be auto-focused when it is
inserted into the document or re-activated when inside a Vue `<keep-alive>` component. Note that
this prop **does not** set the `autofocus` attribute on the input.
Expand Down
1 change: 0 additions & 1 deletion src/components/form-file/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
"version": "1.0.0",
"meta": {
"title": "Form File",
"enhanced": true,
"description": "Customized, cross-browser consistent, file input control that supports single file, multiple files, and directory upload.",
"components": [
{
Expand Down
2 changes: 0 additions & 2 deletions src/components/form-input/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -482,8 +482,6 @@ Emulation of the `.lazy` modifier is _not_ supported (listen for `change` or `bl

## Autofocus

<span class="badge badge-info small">NEW in 2.0.0-rc.21</span>

When the `autofocus` prop is set, the input will be auto-focused when it is inserted into the
document, or re-activated when inside a Vue `<keep-alive>` component. Note that this prop **does
not** set the `autofocus` attribute on the input.
Expand Down
Loading