# @prakashdivyy/vue-redoc-wrapper

> A Vue.js wrapper component for ReDoc

Latest version **0.0.1** (published 2022-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @prakashdivyy/vue-redoc-wrapper
pnpm add @prakashdivyy/vue-redoc-wrapper
yarn add @prakashdivyy/vue-redoc-wrapper
bun add @prakashdivyy/vue-redoc-wrapper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-05-06 |
| First published | 2022-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.7 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | prakashdivyy |
| Maintainers | prakashdivyy |

## Links

- npm: https://www.npmjs.com/package/@prakashdivyy/vue-redoc-wrapper
- Repository: https://github.com/prakashdivyy/vue-redoc-wrapper
- Homepage: https://github.com/prakashdivyy/vue-redoc-wrapper#readme
- Issues: https://github.com/prakashdivyy/vue-redoc-wrapper/issues
- npm.io page: https://npm.io/package/@prakashdivyy/vue-redoc-wrapper

## Dependencies (2)

- [vue](https://npm.io/package/vue.md) ^2.6.10
- [core-js](https://npm.io/package/core-js.md) ^3.4.3

## Recent versions

- 0.0.1 (latest) — 2022-05-06

## README

# vue-redoc-wrapper

A Vue.js wrapper component for [ReDoc](https://github.com/Redocly/redoc).

[![npm package](https://img.shields.io/npm/v/@prakashdivyy/vue-redoc-wrapper.svg?style=flat-square)](https://www.npmjs.com/package/@prakashdivyy/vue-redoc-wrapper)

## Installation

```bash
npm install @prakashdivyy/vue-redoc-wrapper --save
```

## Usage

Pass the [OpenAPI definitions](https://swagger.io/specification/#schema) of your API to the spec-or-spec-url attribute of the component.
The attribute value can be given as an object or as a URL to the JSON or YAML file for your API documentation.

```html
<template>
  <div id="app">
    <redoc-wrapper
      :spec-or-spec-url="'http://petstore.swagger.io/v2/swagger.json'"
      :options="redocOptions"
    ></redoc-wrapper>
  </div>
</template>

<script>
  import RedocWrapper from "@prakashdivyy/vue-redoc-wrapper";

  export default {
    name: "app",
    components: {
      RedocWrapper,
    },
    data() {
      return {
        // https://github.com/Redocly/redoc#redoc-options-object
        redocOptions: {
          hideDownloadButton: false,
        },
      };
    },
  };
</script>
```

### Component Props

The component exposes two props: _specOrSpecUrl_ (required) and _options_ (optional). Please visit the documentation for
[ReDoc's standalone version](https://github.com/Redocly/redoc#advanced-usage-of-standalone-version) for more information on their usage.

## Demo

```bash
vue serve demo/components/SpecUrlExample.vue
```

---
_Source: https://npm.io/package/@prakashdivyy/vue-redoc-wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._