Skip to content

Commit 54cc7a4

Browse files
authored
Merge pull request #36 from uploadcare/feat/rename-to-file-uploader
feat: Updated Readme.md and renamed to file-uploader
2 parents 84c73d8 + 23969c9 commit 54cc7a4

File tree

22 files changed

+100
-101
lines changed

22 files changed

+100
-101
lines changed

README.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<a href="https://uploadcare.com/?ref=github-blocks-examples-readme">
2+
<a href="https://uploadcare.com/?ref=github-file-uploader-examples-readme">
33
<picture>
44
<source media="(prefers-color-scheme: light)" srcset="https://ucarecdn.com/1b4714cd-53be-447b-bbde-e061f1e5a22f/logo-safespace-transparent.svg">
55
<source media="(prefers-color-scheme: dark)" srcset="https://ucarecdn.com/3b610a0a-780c-4750-a8b4-3bf4a8c90389/logo-transparent-inverted.svg">
@@ -8,38 +8,40 @@
88
</a>
99
</p>
1010
<p align="center">
11-
<a href="https://uploadcare.com?ref=github-blocks-examples-readme">Website</a> •
12-
<a href="https://uploadcare.com/docs/start/quickstart?ref=github-blocks-examples-readme">Quick Start</a> •
13-
<a href="https://uploadcare.com/docs?ref=github-blocks-examples-readme">Docs</a> •
14-
<a href="https://uploadcare.com/blog?ref=github-blocks-examples-readme">Blog</a> •
15-
<a href="https://discord.gg/mKWRgRsVz8?ref=github-blocks-examples-readme">Discord</a> •
16-
<a href="https://twitter.com/Uploadcare?ref=github-blocks-examples-readme">Twitter</a>
11+
<a href="https://uploadcare.com?ref=github-file-uploader-examples-readme">Website</a> •
12+
<a href="https://uploadcare.com/docs/start/quickstart?ref=github-file-uploader-examples-readme">Quick Start</a> •
13+
<a href="https://uploadcare.com/docs?ref=github-file-uploader-examples-readme">Docs</a> •
14+
<a href="https://uploadcare.com/blog?ref=github-file-uploader-examples-readme">Blog</a> •
15+
<a href="https://discord.gg/mKWRgRsVz8?ref=github-file-uploader-examples-readme">Discord</a> •
16+
<a href="https://twitter.com/Uploadcare?ref=github-file-uploader-examples-readme">Twitter</a>
1717
</p>
1818

19-
# 📦 Uploadcare Blocks Examples
19+
# Uploadcare File Uploader Examples
2020

21-
This repository contains a collection of examples demonstrating the integration of the [Uploadcare Blocks](https://github.com/uploadcare/blocks) library with various front-end stacks. Each example is designed to provide a clear and practical guide on implementing file-uploading features using Blocks in your projects.
21+
This repository provides examples of integrating the [Uploadcare File Uploader](https://github.com/uploadcare/file-uploader) into various environments and frameworks.
2222

23-
## Examples
24-
25-
Each directory in this repository represents a different framework maintained by Blocks and contains fully functional file-uploading applications:
23+
Our File Uploader is built using Web Components, which makes it **framework-agnostic**. That means you can integrate it into any project, whether working with React, Vue, Angular, or a plain JavaScript setup. The examples aim to help you implement the uploader into any workflows and use cases, regardless of the specific tech stack.
2624

2725
* [JavaScript](./examples/js-uploader/)
2826
* [React](./examples/react-uploader/)
29-
* [React via Adapter](./examples/react-uploader-adapter/)
3027
* [Angular](./examples/angular-uploader/)
3128
* [Vue](./examples/vue-uploader/)
3229
* [Svelte](./examples/svelte-uploader/)
3330
* [Next.js](./examples/next-uploader/)
31+
32+
We’re always looking to improve and find the best solutions. That’s why we created the [React wrapper](https://github.com/uploadcare/react-components/blob/main/packages/react-uploader/README.md)—to support familiar development patterns and approaches:
33+
34+
* [React via Adapter](./examples/react-uploader-adapter/)
3435
* [Next.js via Adapter](./examples/next-uploader-adapter/)
3536

37+
## Lack an example?
3638

37-
Each example provides a live demo, instructions to run it locally, and helpful tips right in the code.
39+
If you need help with your stack or have a specific question or use case, feel free to [create an issue](https://github.com/uploadcare/file-uploader-examples/issues). We’re here to explore more integrations and help you out.
3840

3941
## Contribution
4042

4143
You’re always welcome to contribute:
42-
* Create [issues](https://github.com/uploadcare/blocks-examples/issues) every time you feel something is missing or goes wrong.
44+
* Create [issues](https://github.com/uploadcare/file-uploader-examples/issues) every time you feel something is missing or goes wrong.
4345
* Provide your feedback or drop us a support request at <a href="mailto:[email protected]">[email protected]</a>.
4446
* Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/uploadcare) with "uploadcare" tag if others can have these questions as well.
4547
* Fork project, make changes and send it as pull request.

examples/angular-uploader/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
<a href="https://twitter.com/Uploadcare?ref=github-angular-example-readme">Twitter</a>
1717
</p>
1818

19-
# Angular File Uploader with Uploadcare Blocks
19+
# Angular file uploading examples
2020

21-
[![Edit angular-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/blocks-examples/tree/main/examples/angular-uploader/)
21+
[![Edit angular-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/file-uploader-examples/tree/main/examples/angular-uploader/)
2222

23-
This is an example project of implementing a file uploader in an Angular application with [Uploadcare Blocks](https://github.com/uploadcare/blocks).
23+
This is an example project of implementing a file uploader in an Angular application with [Uploadcare File Uploader](https://github.com/uploadcare/file-uploader).
2424

2525
## Run this demo locally
2626

@@ -51,7 +51,7 @@ Please, read the [File Uploader documentation](https://uploadcare.com/docs/file-
5151

5252
### Angular + Web Components
5353

54-
Blocks are native to the Web but not to Angular. However, Angular does everything to make solutions based on Web Components
54+
File Uploader is native to the Web but not to Angular. However, Angular does everything to make solutions based on Web Components
5555
to work properly with it.
5656

5757
To help Angular to figure out where you're using Web Components, you have to set
@@ -64,7 +64,7 @@ if you want to know more about using custom elements in Angular.
6464

6565
### Styling
6666

67-
If your styling solution may provide class string or style object, feel free to use them on blocks like
67+
If your styling solution may provide class string or style object, feel free to use them on components like
6868
`uc-file-uploader-regular` and override default class using CSS variables.
6969

7070
Otherwise you may go “full override” way and pass a string with styles to a File Uploader type of your choice.

examples/angular-uploader/src/app/app.component.html

+11-20
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
<svg xmlns="http://www.w3.org/2000/svg" focusable="false" viewBox="0 0 18 18" width="30" height="30">
44
<circle cx="9" cy="9" r="9" fill="url(#gradient)"></circle>
55
<defs>
6-
<radialGradient id="gradient" cx="0" cy="0" r="1" gradientTransform="rotate(149.216 9.368 7.42) scale(17.5848 20.2492)" gradientUnits="userSpaceOnUse">
6+
<radialGradient id="gradient" cx="0" cy="0" r="1"
7+
gradientTransform="rotate(149.216 9.368 7.42) scale(17.5848 20.2492)" gradientUnits="userSpaceOnUse">
78
<stop stop-color="#FFC700"></stop>
89
<stop offset="1" stop-color="#FFEDAB"></stop>
910
</radialGradient>
@@ -13,41 +14,31 @@
1314

1415
<ul class="menu">
1516
<li class="menu-item">
16-
<a
17-
class="link menu-link"
18-
routerLink="form"
19-
routerLinkActive="active"
20-
>Real-life form</a>
17+
<a class="link menu-link" routerLink="form" routerLinkActive="active">Real-life form</a>
2118
</li>
2219

2320
<li class="menu-item">
24-
<a
25-
class="link menu-link"
26-
routerLink="minimal"
27-
routerLinkActive="active"
28-
>Minimal uploader</a>
21+
<a class="link menu-link" routerLink="minimal" routerLinkActive="active">Minimal uploader</a>
2922
</li>
3023

3124
<li class="menu-item">
32-
<a
33-
class="link menu-link"
34-
routerLink="regular"
35-
routerLinkActive="active"
36-
>Regular uploader</a>
25+
<a class="link menu-link" routerLink="regular" routerLinkActive="active">Regular uploader</a>
3726
</li>
3827
</ul>
3928

4029
<div class="source">
4130
<span class="source-title">
42-
Built with Uploadcare Blocks and Angular
31+
Built with Uploadcare File Uploader and Angular
4332
</span>
4433

45-
<a class="link" href="https://github.com/uploadcare/blocks-examples/tree/main/examples/angular-uploader">
34+
<a class="link" href="https://github.com/uploadcare/file-uploader-examples/tree/main/examples/angular-uploader">
4635
<svg xmlns="http://www.w3.org/2000/svg" focusable="false" viewBox="0 0 24 24" width="30" height="30">
47-
<path fill="#24292f" style="fill: var(--ui-control-text-color)" stroke="none" d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"></path>
36+
<path fill="#24292f" style="fill: var(--ui-control-text-color)" stroke="none"
37+
d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12">
38+
</path>
4839
</svg>
4940
</a>
5041
</div>
5142
</nav>
5243

53-
<router-outlet></router-outlet>
44+
<router-outlet></router-outlet>

examples/angular-uploader/src/app/components/file-uploader/file-uploader.component.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div class="root">
22
<!--
3-
Note: `uc-config` is the main block we use to configure File Uploader.
4-
It's important to all the context-related blocks to have the same `ctx-name` attribute.
3+
Note: `uc-config` is the main component we use to configure File Uploader.
4+
It's important to all the context-related File Uploader to have the same `ctx-name` attribute.
55
66
See more: https://uploadcare.com/docs/file-uploader/configuration/
77
Available options: https://uploadcare.com/docs/file-uploader/options/

examples/angular-uploader/src/styles.scss

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
Go to https://uploadcare.com/docs/file-uploader/styling/
3-
to read more about Blocks styling
3+
to read more about File Uploader styling
44
*/
55
@import '@uploadcare/file-uploader/web/uc-file-uploader-regular.min.css';
66
@import '@uploadcare/file-uploader/web/uc-file-uploader-minimal.min.css';

examples/js-custom-tab/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Blocks composition examples
1+
# File Uploader composition examples
22

3-
[![Edit composition](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/blocks-examples/tree/main/examples/composition/)
3+
[![Edit composition](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/file-uploader-examples/tree/main/examples/composition/)
44

55

66
## Run this demo locally

examples/js-uploader/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616
<a href="https://twitter.com/Uploadcare?ref=github-js-example-readme">Twitter</a>
1717
</p>
1818

19-
# JS File Uploader with Uploadcare Blocks
19+
# JS file uploading example
2020

21-
[![Edit js-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/blocks-examples/tree/main/examples/js-uploader/)
21+
[![Edit js-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/file-uploader-examples/tree/main/examples/js-uploader/)
22+
23+
This is an example project of implementing a file uploader in an JacaScript application with [Uploadcare File Uploader](https://github.com/uploadcare/file-uploader)
2224

2325
## Run this demo locally
2426

@@ -39,7 +41,7 @@ $ npm run start
3941

4042
You’re always welcome to contribute:
4143

42-
* Create [issues](https://github.com/uploadcare/blocks-examples/issues) every time you feel something is missing or goes wrong.
44+
* Create [issues](https://github.com/uploadcare/file-uploader-examples/issues) every time you feel something is missing or goes wrong.
4345
* Provide your feedback or drop us a support request at <a href="mailto:[email protected]">[email protected]</a>.
4446
* Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/uploadcare) with "uploadcare" tag if others can have these questions as well.
4547
* Star this repo if you like it ⭐️

examples/next-uploader-adapter/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616
<a href="https://twitter.com/Uploadcare?ref=github-next-example-readme">Twitter</a>
1717
</p>
1818

19-
# Next.js File Uploader with Uploadcare Blocks
19+
# Next.js file uploading example
2020

21-
[![Edit next-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/blocks-examples/tree/main/examples/next-uploader-adapter/)
21+
[![Edit next-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/file-uploader-examples/tree/main/examples/next-uploader-adapter/)
22+
23+
This is an example project of implementing a file uploader in a Next.js application with [Uploadcare React Uploader](https://github.com/uploadcare/react-components/blob/main/packages/react-uploader)
2224

2325
## Run this demo locally
2426

@@ -38,7 +40,7 @@ $ npm run start
3840

3941
You’re always welcome to contribute:
4042

41-
* Create [issues](https://github.com/uploadcare/blocks-examples/issues) every time you feel something is missing or goes wrong.
43+
* Create [issues](https://github.com/uploadcare/file-uploader-examples/issues) every time you feel something is missing or goes wrong.
4244
* Provide your feedback or drop us a support request at <a href="mailto:[email protected]">[email protected]</a>.
4345
* Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/uploadcare) with "uploadcare" tag if others can have these questions as well.
4446
* Star this repo if you like it ⭐️

examples/next-uploader/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616
<a href="https://twitter.com/Uploadcare?ref=github-next-example-readme">Twitter</a>
1717
</p>
1818

19-
# Next.js File Uploader with Uploadcare Blocks
19+
# Next.js file uploading example
2020

21-
[![Edit next-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/blocks-examples/tree/main/examples/next-uploader/)
21+
[![Edit next-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/file-uploader-examples/tree/main/examples/next-uploader/)
22+
23+
This is an example project of implementing a file uploader in a Next.js application with [Uploadcare File Uploader](https://github.com/uploadcare/file-uploader)
2224

2325
## Run this demo locally
2426

@@ -38,7 +40,7 @@ $ npm run start
3840

3941
You’re always welcome to contribute:
4042

41-
* Create [issues](https://github.com/uploadcare/blocks-examples/issues) every time you feel something is missing or goes wrong.
43+
* Create [issues](https://github.com/uploadcare/file-uploader-examples/issues) every time you feel something is missing or goes wrong.
4244
* Provide your feedback or drop us a support request at <a href="mailto:[email protected]">[email protected]</a>.
4345
* Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/uploadcare) with "uploadcare" tag if others can have these questions as well.
4446
* Star this repo if you like it ⭐️

examples/react-uploader-adapter/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
<a href="https://twitter.com/Uploadcare?ref=github-react-example-readme">Twitter</a>
1717
</p>
1818

19-
# React File Uploader with Uploadcare Blocks
19+
# React file uploading example
2020

21-
[![Edit react-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/blocks-examples/tree/main/examples/react-uploader-adapter/)
21+
[![Edit react-uploader](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/uploadcare/file-uploader-examples/tree/main/examples/react-uploader-adapter/)
2222

23-
This is an example project of implementing a file uploader in a React application with [Uploadcare Blocks](https://github.com/uploadcare/blocks).
23+
This is an example project of implementing a file uploader in a Next.js application with [Uploadcare React Uploader](https://github.com/uploadcare/react-components/blob/main/packages/react-uploader)
2424

2525
## Run this demo locally
2626

@@ -49,14 +49,14 @@ Please, read the [File Uploader documentation](https://uploadcare.com/docs/file-
4949

5050
## Integration notes
5151

52-
Blocks are native to the Web but not to React. It's easy to use Blocks in a React app, but note that a part of your solution will encapsulate non-React code.
52+
File Uploader is native to the Web but not to React. It's easy to use File Uploader in a React app, but note that a part of your solution will encapsulate non-React code.
5353

5454
E.g. in one of the examples we created a [FileUploader](src/components/FileUploader/FileUploader.tsx) component
55-
which provides React-friendly API for the rest of the view. There are Blocks inside of this component and nowhere else.
55+
which provides React-friendly API for the rest of the view. There is a File Uploader inside this component and nowhere else.
5656

5757
### Styling
5858

59-
If your styling solution may provide class string or style object, feel free to use them on blocks like
59+
If your styling solution may provide class string or style object, feel free to use them on components like
6060
`uc-file-uploader-regular` and override default class using CSS variables.
6161

6262
Otherwise you may go “full override” way and pass a string with styles to a File Uploader type of your choice.
@@ -67,7 +67,7 @@ Otherwise you may go “full override” way and pass a string with styles to a
6767

6868
You’re always welcome to contribute:
6969

70-
* Create [issues](https://github.com/uploadcare/blocks-examples/issues) every time you feel something is missing or goes wrong.
70+
* Create [issues](https://github.com/uploadcare/file-uploader-examples/issues) every time you feel something is missing or goes wrong.
7171
* Provide your feedback or drop us a support request at <a href="mailto:[email protected]">[email protected]</a>.
7272
* Ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/uploadcare) with "uploadcare" tag if others can have these questions as well.
7373
* Star this repo if you like it ⭐️

examples/react-uploader-adapter/src/components/Layout/Layout.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ export default function Layout() {
4949

5050
<div className={st.source}>
5151
<span className={st.sourceTitle}>
52-
Built with Uploadcare Blocks and React
52+
Built with Uploadcare File Uploader and React
5353
</span>
5454

55-
<a className={st.link} href="https://github.com/uploadcare/blocks-examples/tree/main/examples/react-uploader">
55+
<a className={st.link} href="https://github.com/uploadcare/file-uploader-examples/tree/main/examples/react-uploader">
5656
<svg xmlns="http://www.w3.org/2000/svg" focusable="false" viewBox="0 0 24 24" width="30" height="30">
5757
<path fill="#24292f" style={{ fill: 'var(--ui-control-text-color)' }} stroke="none" d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"></path>
5858
</svg>

0 commit comments

Comments
 (0)