mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
ca2b50a0a7
Follow-up to #48344: collapses the two resolution paths for the Admonition module into one. `src/admonition.tsx` was a back-compat shim re-exporting `src/Admonition/`. Two ways to resolve one module is exactly what produced the macOS self-import bug fixed in #48344, and the local typecheck errors that #48374 worked around. This removes the shim and standardizes on the PascalCase subpath, matching every other export in the package. **Changed:** - Codemodded all 246 `ui-patterns/admonition` imports to `ui-patterns/Admonition` (240 `.tsx`, 5 `.mdx`, 1 `.ts` across studio, docs, www, design-system, and lite-studio) - Pointed the 5 internal `'../admonition'` imports back at the `'../Admonition'` directory **Removed:** - `packages/ui-patterns/src/admonition.tsx`, and its `./admonition` entry in the exports map (regenerated with `pnpm gen:exports`) ## To test - `grep -r "ui-patterns/admonition" --include='*.ts*'` → no hits - `pnpm test:case-hazards` → passes - `pnpm typecheck` → all 15 tasks green - `pnpm --filter studio run lint:ratchet` → passes - `pnpm --filter ui-patterns vitest run src/Admonition` → 11 tests pass <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Standardized Admonition component imports across the application and documentation. * Improved compatibility with case-sensitive environments by using the canonical component path. * Removed the legacy Admonition import entry point. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
48 lines
2.3 KiB
Plaintext
48 lines
2.3 KiB
Plaintext
import { Admonition } from 'ui-patterns/Admonition'
|
|
|
|
## Prerequisites
|
|
|
|
You'll need:
|
|
|
|
- A Vonage account (sign up here: https://dashboard.nexmo.com/sign-up)
|
|
- A Supabase project (create one here: https://supabase.com/dashboard)
|
|
- A mobile phone capable of receiving SMS
|
|
|
|
## Set up Vonage as an SMS provider
|
|
|
|
### Getting your Vonage credentials
|
|
|
|
Start by logging into your Vonage Dashboard at https://dashboard.nexmo.com/
|
|
|
|
You will see you API Key and API Secret here, which is actually all you need to get started.
|
|
|
|
In most countries, a phone number is actually optional and you can also use any Alphanumeric Sender ID of up to 11 characters length (8 for India) as a Sender ID (from). This means you do not need a number to test with in most cases.
|
|
|
|
To find out more about supported countries for Alphanumeric Sender ID, check this overview: https://help.nexmo.com/hc/en-us/articles/115011781468-SMS-Features-Overview-Outbound-only-
|
|
|
|
Hint: Some countries might need a Sender ID Registration to allow sending with an Alphanumeric Sender ID. You can find this information in the help article as well. If Alpha Sender IDs are not supported, you will need to buy a phone number.
|
|
|
|
### Getting a phone number (optional)
|
|
|
|
If you want a phone number to send SMS from, you can buy one from the Vonage Dashboard under Numbers > Buy Numbers (https://dashboard.nexmo.com/buy-numbers).
|
|
|
|
Select the country you want a number for. You will need a mobile phone number with SMS or SMS+Voice capability. After you have bought the number, you will be able to send SMS from it.
|
|
|
|
### Configure Supabase
|
|
|
|
Now go to the [Auth > Providers](https://supabase.com/dashboard/project/_/auth/providers) page in the Supabase dashboard and select "Phone" from the Auth Providers list.
|
|
|
|
You should see an option to enable the Phone provider.
|
|
|
|
Toggle it on, and copy the API key, API secret and phone number values over from the Vonage dashboard. Click save.
|
|
|
|
Now the backend should be setup, we can proceed to add our client-side code!
|
|
|
|
#### SMS custom template
|
|
|
|
The SMS message sent to a phone containing an OTP code can be customized. This is useful if you need to mention a brand name or display a website address.
|
|
|
|
Go to [Auth > Templates](https://supabase.com/dashboard/project/_/auth/templates) page in the Supabase dashboard.
|
|
|
|
Use the variable `.Code` in the template to display the code.
|