Skip to content

Latest commit

 

History

History
executable file
·
43 lines (28 loc) · 1.48 KB

README.md

File metadata and controls

executable file
·
43 lines (28 loc) · 1.48 KB
Raw

Files

The files service provides functionality to manage, retrieve, share files in Kibana.

Overview

The file service provides the following capabilities to plugins to create, manage and share file contents:

  • Auto-register HTTP APIs for your file
    • These HTTP APIs can also be access controlled
  • A server-side client
  • A browser-side client
  • Various reusable UI components that can provide a consistent user experience
  • Publicly sharing files (i.e., bypassing all security)
  • Leveraging file caching where possible

Getting started

See the tutorial.

API reference

See the reference.

Public components

To see any component in action run yarn storybook files and follow the prompts

The files service offers a number of UI components that are reusable UIs to provide a consistent UX for managing files while keeping integration with the file service light for consumers.

  • <Image /> - A specialized component for efficiently downloading and rendering files in the UI that wraps an img tag.
  • <UploadFile /> - The EuiFilePicker wrapped with robust upload logic for one or multiple files
  • <FilePicker /> - A way for users to view and select from one or more uploaded files

in the terminal.

Development

See the kibana contributing guide for instructions setting up your development environment.