Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syropian/vue-input-autowidth

A Vue.js directive that automatically resizes an input's width to fit its contents.
https://github.com/syropian/vue-input-autowidth

auto-width input vue vue2 vue3

Last synced: 1 day ago
JSON representation

A Vue.js directive that automatically resizes an input's width to fit its contents.

Awesome Lists containing this project

README

        

# vue-input-autowidth ![tests](https://github.com/syropian/vue-input-autowidth/workflows/tests/badge.svg?branch=v2)

A Vue.js directive that automatically resizes an input's width to fit its contents.

> 🚦 Looking for Vue 2 support? Check out the [master branch](https://github.com/syropian/vue-input-autowidth).

#### [See demo](https://vue-input-autowidth.netlify.app/)

## Installation

```bash
npm install vue-input-autowidth@next --save
# or...
yarn add vue-input-autowidth@next
```

_or_

Use the UMD build from [Unpkg](https://unpkg.com/vue-input-autowidth), available as `VueInputAutowidth` in the global scope.

```html

```

## Usage

### Globally

Import and register the directive in your app's entrypoint.

```js
import { createApp } from 'vue'
import App from './App.vue'
import { plugin as VueInputAutowidth } from 'vue-input-autowidth'

createApp(App).use(VueInputAutowidth).mount('#app')
```

### Per-component

```js

import { directive as VueInputAutowidth } from "vue-input-autowidth"

export default {
directives: { autowidth: VueInputAutowidth },
setup() {
...
},
}

```

...and in your template:

```html

```

You can also pass some options:

```html

```

## Available Options

| Name | Type | Default Value | Description |
| ----------------------------------- | --------- | ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **maxWidth** | `string` | `undefined` | Sets the `max-width` CSS property on the element. The value should be a valid CSS size and unit. |
| **minWidth** | `string` | `undefined` | Sets the `min-width` CSS property on the element. The value should be a valid CSS size and unit. |
| **comfortZone** | `string` | `0px` | Uses CSS `calc()` to add the specificied amount to the calculated width. The value should be a valid CSS size and unit. |
| **watchWindowSize** | `boolean` | `false` | When enabled, the directive will listen to the window resize event, and resize the input if needed. |
| **windowResizeHandlerDebounceTime** | `number` | `150` | The debounce time in milliseconds for the window resize event. Only applies if `watchWindowSize` is `true`. |
| **disableNonInputWarning** | `boolean` | `false` | Disables the console warning if you try and use the directive on a non-input element. |

## License

MIT © [Collin Henderson](https://github.com/syropian)