From c85155ec0b0df7535edc597409bd4ab5365e9479 Mon Sep 17 00:00:00 2001 From: Axel Navarro Date: Sun, 13 Mar 2022 15:47:44 -0300 Subject: [PATCH] svgr: add page (#7882) --- pages/common/svgr.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 pages/common/svgr.md diff --git a/pages/common/svgr.md b/pages/common/svgr.md new file mode 100644 index 000000000..6ef5bac85 --- /dev/null +++ b/pages/common/svgr.md @@ -0,0 +1,32 @@ +# svgr + +> Transform SVGs into React components. +> More information: . + +- Transform a SVG file into a React component to stdout: + +`svgr -- {{path/to/file.svg}}` + +- Transform a SVG file into a React component using TypeScript to stdout: + +`svgr --typescript -- {{path/to/file.svg}}` + +- Transform a SVG file into a React component using JSX transform to stdout: + +`svgr --jsx-runtime automatic -- {{path/to/file.svg}}` + +- Transform all SVG files from a directory to React components into a specific directory: + +`svgr --out-dir {{path/to/output_directory}} {{path/to/input_directory}}` + +- Transform all SVG files from a directory to React components into a specific directory skipping already transformed files: + +`svgr --out-dir {{path/to/output_directory}} --ignore-existing {{path/to/input_directory}}` + +- Transform all SVG files from a directory to React components into a specific directory using a specific case for filenames: + +`svgr --out-dir {{path/to/output_directory}} --filename-case {{camel|kebab|pascal}} {{path/to/input_directory}}` + +- Transform all SVG files from a directory to React components into a specific directory without generating an index file: + +`svgr --out-dir {{path/to/output_directory}} --no-index {{path/to/input_directory}}`