Skip to content

getVideoPlayerOptions#155

Closed
colbyfayock wants to merge 2 commits intomainfrom
feat/154+getvideoplayeroptions
Closed

getVideoPlayerOptions#155
colbyfayock wants to merge 2 commits intomainfrom
feat/154+getvideoplayeroptions

Conversation

@colbyfayock
Copy link
Collaborator

Description

Issue Ticket Number

Fixes #154

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Fix or improve the documentation
  • This change requires a documentation update

Checklist

  • I have followed the contributing guidelines of this project as mentioned in CONTRIBUTING.md
  • I have created an issue ticket for this PR
  • I have checked to ensure there aren't other open Pull Requests for the same update/change?
  • I have performed a self-review of my own code
  • I have run tests locally to ensure they all pass
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes needed to the documentation

@colbyfayock colbyfayock mentioned this pull request May 22, 2024
12 tasks
@colbyfayock
Copy link
Collaborator Author

closed in favor of #156

colbyfayock added a commit that referenced this pull request May 23, 2024
# Description

This lifts the player options logic from Next Cloudinary, which should
basically reflect Nuxt and Svelte.

This allows us to maintain a single set of configuration options for the
player that will support each framework that creates a similar
CldVideoPlayer component.

It would work as such:
```
const playerOptions = getVideoPlayerOptions(props, config);
videoPlayer(videoRef.current, playerOptions);
```

You can see some examples inside of the tests.

As of now, I left out `className` and `id` as returned options as the
function's intent is to return "player options", which would be invalid
values for the player. This in come cases could cause unintentional side
effects, so opting to not return those.

A potential solution would be to return an object, with player options
as a property, but i'm leaning towards it being an unintuitive return
shape given the name of the function. Open to thoughts on this.

As far as where this module is located, I opted to include it in
`/url-loader` with the idea being that the family of component support
functions could live under that package and in a future major release,
we could rename it to something more appropriate for all. I'm open to
other ideas / suggestions on this.

## Issue Ticket Number

Fixes #155 

<!-- Specify above which issue this fixes by referencing the issue
number (`#<ISSUE_NUMBER>`) or issue URL. -->
<!-- Example: Fixes
https://github.com/colbyfayock/cloudinary-util/issues/<ISSUE_NUMBER> -->

## Type of change

<!-- Please select all options that are applicable. -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Fix or improve the documentation
- [ ] This change requires a documentation update


# Checklist

<!-- These must all be followed and checked. -->

- [ ] I have followed the contributing guidelines of this project as
mentioned in [CONTRIBUTING.md](/CONTRIBUTING.md)
- [ ] I have created an
[issue](https://github.com/colbyfayock/cloudinary-util/issues) ticket
for this PR
- [ ] I have checked to ensure there aren't other open [Pull
Requests](https://github.com/colbyfayock/cloudinary-util/pulls) for the
same update/change?
- [ ] I have performed a self-review of my own code
- [ ] I have run tests locally to ensure they all pass
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes needed to the documentation
github-actions bot pushed a commit that referenced this pull request May 23, 2024
@github-actions
Copy link

🎉 This issue has been resolved in version @cloudinary-util/url-loader-v5.3.0-beta.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@colbyfayock colbyfayock mentioned this pull request May 23, 2024
24 tasks
colbyfayock added a commit that referenced this pull request May 23, 2024
# Description

This lifts the player options logic from Next Cloudinary, which should
basically reflect Nuxt and Svelte.

This allows us to maintain a single set of configuration options for the
player that will support each framework that creates a similar
CldVideoPlayer component.

It would work as such:
```
const playerOptions = getVideoPlayerOptions(props, config);
videoPlayer(videoRef.current, playerOptions);
```

You can see some examples inside of the tests.

As of now, I left out `className` and `id` as returned options as the
function's intent is to return "player options", which would be invalid
values for the player. This in come cases could cause unintentional side
effects, so opting to not return those.

A potential solution would be to return an object, with player options
as a property, but i'm leaning towards it being an unintuitive return
shape given the name of the function. Open to thoughts on this.

As far as where this module is located, I opted to include it in
`/url-loader` with the idea being that the family of component support
functions could live under that package and in a future major release,
we could rename it to something more appropriate for all. I'm open to
other ideas / suggestions on this.

## Issue Ticket Number

Fixes #155 

<!-- Specify above which issue this fixes by referencing the issue
number (`#<ISSUE_NUMBER>`) or issue URL. -->
<!-- Example: Fixes
https://github.com/colbyfayock/cloudinary-util/issues/<ISSUE_NUMBER> -->

## Type of change

<!-- Please select all options that are applicable. -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Fix or improve the documentation
- [ ] This change requires a documentation update


# Checklist

<!-- These must all be followed and checked. -->

- [ ] I have followed the contributing guidelines of this project as
mentioned in [CONTRIBUTING.md](/CONTRIBUTING.md)
- [ ] I have created an
[issue](https://github.com/colbyfayock/cloudinary-util/issues) ticket
for this PR
- [ ] I have checked to ensure there aren't other open [Pull
Requests](https://github.com/colbyfayock/cloudinary-util/pulls) for the
same update/change?
- [ ] I have performed a self-review of my own code
- [ ] I have run tests locally to ensure they all pass
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes needed to the documentation

# Description

<!-- Include a summary of the change made and also list the dependencies
that are required if any -->

## Issue Ticket Number

Fixes #<ISSUE_NUMBER>

<!-- Specify above which issue this fixes by referencing the issue
number (`#<ISSUE_NUMBER>`) or issue URL. -->
<!-- Example: Fixes
https://github.com/colbyfayock/cloudinary-util/issues/<ISSUE_NUMBER> -->

## Type of change

<!-- Please select all options that are applicable. -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Fix or improve the documentation
- [ ] This change requires a documentation update


# Checklist

<!-- These must all be followed and checked. -->

- [ ] I have followed the contributing guidelines of this project as
mentioned in [CONTRIBUTING.md](/CONTRIBUTING.md)
- [ ] I have created an
[issue](https://github.com/colbyfayock/cloudinary-util/issues) ticket
for this PR
- [ ] I have checked to ensure there aren't other open [Pull
Requests](https://github.com/colbyfayock/cloudinary-util/pulls) for the
same update/change?
- [ ] I have performed a self-review of my own code
- [ ] I have run tests locally to ensure they all pass
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes needed to the documentation

---------

Co-authored-by: semantic-release-bot <semantic-release-bot@martynus.net>
github-actions bot pushed a commit that referenced this pull request May 23, 2024
@github-actions
Copy link

🎉 This issue has been resolved in version @cloudinary-util/url-loader-v5.3.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RFC: getVideoPlayerOptions

1 participant