Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds the watermark component #6

Merged
merged 6 commits into from
Aug 2, 2024
Merged

Adds the watermark component #6

merged 6 commits into from
Aug 2, 2024

Conversation

Krakabek
Copy link
Collaborator

@Krakabek Krakabek commented Aug 1, 2024

Description:

Adds a simple watermark component

🧪 Testing Steps / Validation

Tested in Play

✅ Checks

  • Contributor License Agreement (CLA) completed if not a Reddit employee

@Krakabek Krakabek self-assigned this Aug 1, 2024
Copy link
Member

@niedzielski niedzielski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great work! high polish! 💯

@@ -0,0 +1,135 @@
import { Devvit } from "@devvit/public-api";

/**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggest moving the prop docs to separate JSDocs colocated with the props. when we document them in a big block like this, the IDE can't parse it and readability everywhere outside this site is much lower. you might be able to use @prop syntax but I discourage it since it's so much more verbose and you have to keep the name in the docs aligned to the name in the code.


/**
* A component that appends the watermark to the container it is wrapped around
* @param appName - the app name that is specified in devvit.yaml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these docs need to be on WatermarkProps.

props,
context,
) => {
const is1stPartyApp = props.developer === "Reddit";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔕 I don't know if this varies across languages. I guess we're pretty single lingual right now regardless.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This watermark is a temporary solution and will be deprecated before translation is an issue

@Krakabek Krakabek merged commit 3d18f39 into main Aug 2, 2024
1 check passed
@Krakabek Krakabek deleted the watermark-v1 branch August 2, 2024 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants